This repository contains several Node packages, located under the packages/ subdirectory. See each individual package for details:

• colossus - the main colossus app.
• storage - abstraction over the storage backend.
• runtime-api - convenience wrappers for the runtime API.
• crypto - cryptographic utility functions.
• util - general utility functions.
• discovery - service discovery using IPNS.

Installation

Requirements

This project uses yarn as Node package manager. It also uses some node packages with native components, so make sure to install your system's basic build tools.

On Debian-based systems:

$ apt install build-essential

On Mac OS (using homebrew):

$ brew install libtool automake autoconf

Building

$ yarn install

The command will install dependencies, and make a colossus executable available:

$ yarn run colossus --help

Testing

Running tests from the repository root will run tests from all packages:

$ yarn run test

Detailed Setup and Configuration Guide

For details on how to setup a storage node on the Joystream network, follow this step by step guide.