This is the main code repository for all Joystream software. In this mono-repo you will find all the software required to run a Joystream network: The Joystream full node, runtime and all reusable substrate runtime modules that make up the Joystream runtime. In addition to all front-end apps and infrastructure servers necessary for operating the network.
The following tools are required for building, testing and contributing to this repo:
- Rust toolchain - required
- nodejs v12.x - required
- yarn classic package manager v1.22.x- required
- docker and docker-compose - optional
- ansible - optional
If you use VSCode as your code editor we recommend using the workspace settings for recommend eslint plugin to function properly.
After cloning the repo run the following initialization scripts:
# Install rust toolchain ./setup.sh # Install npm package dependencies, build packages and docker images yarn build # start a local development network yarn start
Server Applications - infrastructure
- Storage Node - Media Storage Infrastructure
- Query Node - under development
- Discovery Node - under development
Tools and CLI
- joystream-cli - CLI for community and governance activities
- Network integration - Joystream network integration testing framework
Exploring the network with Pioneer
Pioneer is currently the main web interface to interact with the network:
Currently hosted on: https://testnet.joystream.org
You may have to disable some privacy/ad-blocker extensions in your browser for proper functionality, especially when browsing media.
You can also run a local development instance:
The HEAD of the master branch should always be used for the correct version of the applications to connect to the current testnet:
git checkout master yarn install yarn build:packages yarn workspace pioneer start
This runs a local development web server on port 3000.
Use the link below to browse the network using the publicly hosted endpoint: http://localhost:3000/?rpc=wss://rome-rpc-endpoint.joystream.org:9944/
Running a local full node
You can also run your our own joystream-node:
git checkout master WASM_BUILD_TOOLCHAIN=nightly-2021-03-24 cargo build --release ./target/release/joystream-node -- --pruning archive --chain testnets/joy-testnet-5.json
Wait for the node to sync to the latest block, then change pioneer settings "remote node" option to "Local Node", or follow the link below:
Learn more about joystream-node.
A step by step guide to setup a full node and validator on the Joystream testnet, can be found here.
We have lots of good first issues open to help you get started on contributing code. If you are not a developer you can still make valuable contributions by testing our software and providing feedback and opening new issues.
A description of our branching model will help you to understand where work on different software components happens, and consequently where to direct your pull requests.
We rely on
prettier for consistent formatting. For Rust we rely on
The husky npm package is used to manage the project git-hooks. This is automatically installed and setup when you run
git commit and
git push some scripts will run automatically to ensure committed code passes lint, tests, and code-style checks.
During a rebase/merge you may want to skip all hooks, you can use
HUSKY_SKIP_HOOKS environment variable.
HUSKY_SKIP_HOOKS=1 git rebase ...
RLS Extension in VScode or Atom Editors
If you use RLS extension in your IDE, start your editor with the
BUILD_DUMMY_WASM_BINARY=1 environment set to workaround a build issue that occurs in the IDE only.
BUILD_DUMMY_WASM_BINARY=1 code ./joystream
See the list of contributors who participated in this project.
All software under this project is licensed as GPLv3 unless otherwise indicated.
Thanks to the whole Parity Tech team for making substrate and helping in chat with tips, suggestions, tutorials and answering all our questions during development.