Mokhtar Naamani 544f084234 storage-node: mark workspace packages private 4 years ago
..
docs 34358429f8 move storage node into storage-node/ folder 4 years ago
packages 544f084234 storage-node: mark workspace packages private 4 years ago
scripts 85fb7d44fc storage-node: run tests when starting dev instance 4 years ago
.eslintrc.js 34358429f8 move storage node into storage-node/ folder 4 years ago
.gitignore fff4d37935 storage node refactoring 4 years ago
.travis.yml 34358429f8 move storage node into storage-node/ folder 4 years ago
LICENSE.md 34358429f8 move storage node into storage-node/ folder 4 years ago
README.md 34358429f8 move storage node into storage-node/ folder 4 years ago
license_header.txt 34358429f8 move storage node into storage-node/ folder 4 years ago
package.json 7ab498bea0 integrate storage-node into root yarn worksapce 4 years ago
storage-node_new.svg 34358429f8 move storage node into storage-node/ folder 4 years ago

README.md

Storage Nodes for Joystream

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.