-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
2 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,59 +1,3 @@ | ||
# Unzoom | ||
# Unzoom. | ||
|
||
## Environment Setup | ||
|
||
> PREREQUISITE: set up the [holochain development environment](https://developer.holochain.org/docs/install/). | ||
Enter the nix shell by running this in the root folder of the repository: | ||
|
||
```bash | ||
nix-shell | ||
npm install | ||
``` | ||
|
||
**Run all the other instructions in this README from inside this nix-shell, otherwise they won't work**. | ||
|
||
## Running 2 agents | ||
|
||
```bash | ||
npm start | ||
``` | ||
|
||
This will create a network of 2 nodes connected to each other and their respective UIs. | ||
It will also bring up the Holochain Playground for advanced introspection of the conductors. | ||
|
||
## Running the backend tests | ||
|
||
```bash | ||
npm test | ||
``` | ||
|
||
## Bootstrapping a network | ||
|
||
Create a custom network of nodes connected to each other and their respective UIs with: | ||
|
||
```bash | ||
AGENTS=3 npm run network | ||
``` | ||
|
||
Substitute the "3" for the number of nodes that you want to bootstrap in your network. | ||
This will also bring up the Holochain Playground for advanced introspection of the conductors. | ||
|
||
## Packaging | ||
|
||
To package the web happ: | ||
``` bash | ||
npm run package | ||
``` | ||
|
||
You'll have the `unzoom.webhapp` in `workdir`. This is what you should distribute so that the Holochain Launcher can install it. | ||
You will also have its subcomponent `unzoom.happ` in the same folder`. | ||
|
||
## Documentation | ||
|
||
This repository is using these tools: | ||
- [NPM Workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces/): npm v7's built-in monorepo capabilities. | ||
- [hc](https://github.com/holochain/holochain/tree/develop/crates/hc): Holochain CLI to easily manage Holochain development instances. | ||
- [@holochain/tryorama](https://www.npmjs.com/package/@holochain/tryorama): test framework. | ||
- [@holochain/client](https://www.npmjs.com/package/@holochain/client): client library to connect to Holochain from the UI. | ||
- [@holochain-playground/cli](https://www.npmjs.com/package/@holochain-playground/cli): introspection tooling to understand what's going on in the Holochain nodes. | ||
If the integrity and privacy of our means of communication [is at the whim](https://www.schneier.com/blog/archives/2023/08/zoom-can-spy-on-your-calls-and-use-the-conversation-to-train-ai-but-says-that-it-wont.html) of large tech companies - perceptive primarily to maximizing profits and insensitive to their effects on our larger collective wellbeing - it's time to unzoom and see the bigger picture. |