Mokhtar Naamani a7a4f91bd7 storage-node cli: add development commands 4 年 前
..
docs 34358429f8 move storage node into storage-node/ folder 4 年 前
packages a7a4f91bd7 storage-node cli: add development commands 4 年 前
scripts 34358429f8 move storage node into storage-node/ folder 4 年 前
.eslintrc.js 34358429f8 move storage node into storage-node/ folder 4 年 前
.gitignore fff4d37935 storage node refactoring 4 年 前
.travis.yml 34358429f8 move storage node into storage-node/ folder 4 年 前
LICENSE.md 34358429f8 move storage node into storage-node/ folder 4 年 前
README.md 34358429f8 move storage node into storage-node/ folder 4 年 前
license_header.txt 34358429f8 move storage node into storage-node/ folder 4 年 前
package.json 7ab498bea0 integrate storage-node into root yarn worksapce 4 年 前
storage-node_new.svg 34358429f8 move storage node into storage-node/ folder 4 年 前

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.