We

We is a Holochain runtime that makes it trivially easy for groups to build collaboration spaces by composing custom "Applet" suites to meet their collaboration needs.

We is composed of a group management DNA, together with a defined pattern on how to build Applet DNAs that can be added to a We group. Each such group as well as each Applet used within a group is its own private peer-to-peer network.

For more about the motivation behind We, read this blogpost.

Design

For details about the design, read the design document.

Creating We Applets

The details on how to create a we applet can be found here.

Installation

Go to the releases page and download the latest release for your Operating System.

Developer Setup

Installing the repository

1. Install the holochain dev environment: https://developer.holochain.org/docs/install/.
2. Clone this repo: git clone https://github.com/lightningrodlabs/we && cd ./we.
3. Compile holochain and lair. On Linux/macOS you can simply run bash ./scripts/install_binaries.sh. On Windows, follow the instructions in docs/install-binaries.md. DO NOT RUN THIS STEP IN NIX SHELL.
4. Enter the nix shell: nix develop.
5. Run: npm install.
6. Run npm run start.

Running the DNA tests

npm test

UI

To start only one agent:

npm start

To start two agents:

npm run network

Testing with applets

If you already have applets web-happs to test with, add them in the testing-applets folder and run npm start.

The scripts/publish-applets.js is going to be executed when running npm run start, which will publish the applets .webhapp files that it finds in the testing-applets folder.

Note that you need to enter the password in the tauri window and enable dev mode in the App Library within We before the publishing can begin.

To check whether this has finished, look in the terminal for the log: Published applet: [name of your Applet]

Building

Inside the nix shell run:

npm run build:happ

Then, exit the nix shell and run:

npm run tauri build

Tauri will build the executable for your platform and notify you of its location.

License

Copyright (C) 2021, Harris-Braun Enterprises, LLC

This program is free software: you can redistribute it and/or modify it under the terms of the license provided in the LICENSE file (CAL-1.0). This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.