OASIS Holochain hApp

This is the rust based hApp (Holochain App) that forms the DAL (Data Access Layer) to the HoloOASIS OASIS Provider.

Build Instructions

To build simply run the BUILD command from the root of this repo/dir. This command (batch file) will also run the hApp once it has finished building...

You may alternatively manually build it following these instructions:
https://github.com/holochain-open-dev/wiki/wiki/Installing-Holochain--&-Building-hApps-Natively-On-Windows

How To Run

To run simply call the RUN command from the root of this repo/dir.

You may alternatively manually run it following these instructions:
https://github.com/holochain-open-dev/wiki/wiki/Installing-Holochain--&-Building-hApps-Natively-On-Windows

Running In Nix Shell

Alternatively if you want to run in a nix shell, follow the instructions below:

Environment Setup

PREREQUISITE: set up the holochain development environment.

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

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

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

npm 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 oasis.webhapp in workdir. This is what you should distribute so that the Holochain Launcher can install it. You will also have its subcomponent oasis.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.