Hello World Rust Demo

build with scaffolding tool hc version 0.5.0-dev.12

Environment Setup

PREREQUISITE: set up the holochain development environment.

Enter the nix shell by running this in the root folder of the repository:

nix develop
npm install

Run all the other instructions in this README from inside this nix shell, otherwise they won't work.

Running 1 agent

npm run start

This will create a network of 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 client

once code has been cmompiled and the conductor is started, you will be able to see the adminsocket port number for the conductor copy this and execute the command:

./zome_client.bin <port>

the zome_client binary is located in the root workdir alongside the happ.yml

Running the backend tests

npm run test

Bootstrapping a network

Create a custom network of nodes connected to each other and their respective UIs with:

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:

npm run package

You'll have the hello-world.webhapp in workdir. This is what you should distribute so that the Holochain Launcher can install it. You will also have its subcomponent hello-world.happ in the same folder`.

Documentation

This repository is using these tools:

• NPM Workspaces: npm v7's built-in monorepo capabilities.
• hc: Holochain CLI to easily manage Holochain development instances.
• @holochain/tryorama: test framework.
• @holochain/client: client library to connect to Holochain from the UI.
• @holochain-playground/cli: introspection tooling to understand what's going on in the Holochain nodes.