README.md

Request And Offers

Requests And Offers is a hAppenings.community project to facilitate exchange between Holochain creators, developers, advocates, projects and organizations! It's an agent-centric, distributed marketplace of requests and offers built with Holochain.

• Litepaper
• Specifications
• Zomes documentation
  • Users zome
  • Administration zome

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
pnpm install

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

Running 2 agents

pnpm start

This will create a network of 2 nodes connected to their UI. It will also bring up the Holochain Playground for advanced introspection of the conductors.

Running another number of agents

AGENTS=1 pnpm start

It is possible to create a network with a different number of nodes by changing the AGENTS variable.

Running the tests

pnpm test

This command run all the holochain backend tests and the ui tests.

pnpm test:ui

This one run the sveltekit ui tests.

pnpm test:misc

This one run the miscellaneous tests.

pnpm test:users

This one run the users tests of the users_organizations zome.

pnpm test:administration

This one run the administration zome tests.

pnpm test:organizations

This one run the organizations tests of the users_organizations zome.

Packaging

To package the web happ:

pnpm run package

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

License

Cryptographic Autonomy License version 1.0