Holochain

This is the home of the Holochain library, being rewritten from Go into Rust. See https://holochain.org.

Building for Android

Note there is an article written for how to build Holochain for Android, read it here.

State, Reducers, and Actions: The Redux-style Architecture

To read about the redux like architecture, see here.

Local development & testing

NEVER RUN make ON ITS OWN UNLESS YOU KNOW WHAT YOU'RE DOING

CI builds are happening on circle CI.

Docker

The docker folder contains scripts to build and run docker images.

Running tests

Run:

. docker/run-test

Code style

There is a linter/formatter enforcing code style.

Run:

. docker/run-fmt

holochain_101 mdbook

There is an mdbook book on learning holochain at doc/holochain_101.

There is also a docker build that allows local build, serve, watch and live reload for the book.

From the root of the repo, run:

. docker/build-mdbook-image && . docker/run-mdbook

Once the book has built and is serving, visit http://localhost:3000 in the browser.

You can edit the markdown files in doc/holochain_101 and the book will live reload.

To do a one-time build of the files to HTML, run:

. docker/build-mdbook

License

Copyright (C) 2018, Holochain Trust

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

Note: We are considering other 'looser' licensing options (like MIT license) but at this stage are u sing GPL while we're getting the matter sorted out.