Skip to content

Latest commit

 

History

History
112 lines (78 loc) · 5.14 KB

README.md

File metadata and controls

112 lines (78 loc) · 5.14 KB
Raw

Project Forum License: CAL 1.0 Test Twitter Follow

Holochain

Holochain is an open-source framework to develop peer-to-peer applications with high levels of security, reliability, and performance.

This repository contains the Holochain core libraries.

Running Holochain applications (hApps)

Holochain Launcher, the distribution of Holochain for end-users, is supported on all three major desktop platforms. Holochain apps can be installed and run with it. Refer to the Github repository for instructions on how to obtain and use it.

Holochain Development

Code Status

This code is in Alpha. It is not for production use, and currently makes no security guarantees. We will be frequently and heavily restructuring code APIs and data chains until Beta.

Supported OSes

Linux

  • Launcher binaries
  • binaries via crates.io
  • nix package and holonix shell, including execution of binary within holonix CI
  • full functionality test on CI

macOS (x86-64 only, no ARM)

  • Launcher binaries
  • binaries via crates.io
  • nix package and holonix shell, including execution of binary within holonix CI
  • no functionality tests beyond binary execution

Windows

  • Launcher binaries
  • binaries via crates.io
  • no functionality tests

Developing Holochain applications (hApps)

Looking to write a hApp yourself? After setting up your development environment, you can scaffold your hApp. Refer to the Holochain Dev Tools Guide to set up your environment, and see how hApps are scaffolded for creating a hApp template.

Furthermore there's a tutorial on how to build a hApp as well as how to call it from a client.

Contributing to Holochain (this repository)

Holochain is an open source project. We welcome all sorts of participation and are actively working on increasing surface area to accept it. Please see our contributing guidelines for our general practices and protocols on participating in the community, as well as specific expectations around things like code formatting, testing practices, continuous integration, etc.

Connect with us on Discord and our forum.

Development environment setup

The recommended way to set up your development environment is to use the Holochain Dev Tools, also called "Holonix". Holonix is a specification of the necessary tools and libraries to write and build hApps, based on Nix. This guarantees a deterministic development environment across machines and operating systems.

For a reference on how to set up your environment without Holonix, see the corresponding installation instructions at Install Holochain without Holonix.

Usage

$ holochain --help
USAGE:
    holochain [FLAGS] [OPTIONS]

FLAGS:
    -h, --help           Prints help information
    -i, --interactive    Receive helpful prompts to create missing files and directories,
                             useful when running a conductor for the first time
    -V, --version        Prints version information

OPTIONS:
    -c, --config-path <config-path>
            Path to a YAML file containing conductor configuration

Running holochain requires a config file. You can generate one in the default configuration file locations using interactive mode:

$ holochain -i
There is no conductor config YAML file at the path specified (/home/eric/.config/holochain/conductor-config.yml)
Would you like to create a default config file at this location? [Y/n]
Y
Conductor config written.
There is no database set at the path specified (/home/eric/.local/share/holochain/databases)
Would you like to create one now? [Y/n]
Y
Database created.
Conductor ready.

As well as creating the config file, this process also instantiates the database. If you provide a config file on first run with just the -c flag, holochain will also initialize the environment even if not in interactive mode.

License

Copyright (C) 2019-2022, Holochain Foundation

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.