Forked from Joystream/joystream https://github.com/Joystream/joystream

Leszek Wiesner a37b654dc1 Group budget il y a 3 ans
.github 65eab56e9e Speed up integration tests with docker mounts il y a 3 ans
analyses 0d29f2fc70 fee-analysis: update readme il y a 3 ans
cli 3eaecb10e3 Merge branch 'olympia' into types/update-for-olympia il y a 4 ans
content-directory-schemas f0e4c3d459 Merge branch 'olympia-update-from-master' into olympia-update-packages il y a 4 ans
devops 6b6951af79 scripts: Update rust nightly version. il y a 4 ans
metadata-protobuf 847d3ac773 Remove upcoming opening and set group metadata il y a 3 ans
node ef4b7be29a Merge branch 'olympia' into bounty_latest_olympia_update il y a 4 ans
pioneer 3eaecb10e3 Merge branch 'olympia' into types/update-for-olympia il y a 4 ans
query-node a37b654dc1 Group budget il y a 3 ans
runtime e9b5822986 runtime: forum: drop archival status il y a 3 ans
runtime-modules fdc08ab913 runtime: working-group: Change RewardPaid event. il y a 3 ans
scripts 0ef5fa88ac ci: update benchmarks to use less steps il y a 4 ans
storage-node e57a4c7d02 storage-node: update working group related calls in dev-init il y a 4 ans
testnets 1660a22e56 add joy-testnet-4.json il y a 4 ans
tests a37b654dc1 Group budget il y a 3 ans
types 8f9c64bff0 Merge branch 'olympia-types' into working-groups-schemas il y a 3 ans
utils f00b0f6916 integration-tests: memberships il y a 4 ans
.dockerignore 4495ae9230 docker: fix pioneer build - .dockerignore inadvertantly ignoring pioneer code il y a 4 ans
.editorconfig 565ade3481 code style last tweaks, add format and checks yarn scripts il y a 4 ans
.env ee4d5d3056 Query node integration tests setup & initial membership mappings tests il y a 3 ans
.eslintrc.js 1a3bcbfa55 global tsconfig and .eslintrc il y a 4 ans
.gitignore 70c39e9cb3 query-node: check in generted code il y a 4 ans
.prettierrc.js 9da958cc1c pretty some files il y a 4 ans
.yarnclean 643c08c7a0 Pioneer workspaces config etc. il y a 4 ans
Cargo.lock daf5de4a93 Disable “analyses/bench” crate. il y a 4 ans
Cargo.toml 28836363a2 db-bench: fix compilations il y a 3 ans
LICENSE 248dcb5c30 README il y a 4 ans
README.md b5401c2c34 Merge branch 'master' into olympia-update-from-master il y a 4 ans
apps.Dockerfile 2a643ba966 Don't skip cd-schemas in apps.Dockerfile yet il y a 3 ans
build-packages.sh 81fc6d3361 Add missing metadata-protobuf package build on postinstall il y a 3 ans
build.sh 614894faf7 cd-schemas => @joystream/cd-schemas il y a 4 ans
docker-compose.yml 65eab56e9e Speed up integration tests with docker mounts il y a 3 ans
joystream-node.Dockerfile 91d4108ec4 update setup and docker image to use rust 1.47.0, and nightly-2020-10-06 for WASM il y a 4 ans
package.json 81fc6d3361 Add missing metadata-protobuf package build on postinstall il y a 3 ans
rome-testnet.json 361160ddcb referendum - code reformatting il y a 4 ans
setup.sh 4e2bc82c96 setup.sh: source bash_profile il y a 4 ans
start.sh 29c98cb97b do not reload .env in processor-start.sh il y a 4 ans
tsconfig.json 7e97ac9cff Revert "dropped parserOptions.project array from pioneer/.eslintrc.js" il y a 4 ans
yarn.lock 8970a90044 Refactorization part 1: Queries (+ some small fixes) il y a 3 ans

README.md

Joystream

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.

Overview

The Joystream network builds on a pre-release version of substrate v2.0 and adds additional functionality to support the various roles that can be entered into on the platform.

Development Tools

The following tools are required for building, testing and contributing to this repo:

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
# Also good habit to run this when switching between branches
yarn install

# run some tests
yarn cargo-checks

Software

Substrate blockchain

Server Applications - infrastructure

Front-end Applications

  • Pioneer - Main UI for accessing all Joystream features
  • Atlas - Media Player- under development

Tools and CLI

Testing infrastructure

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 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-2020-10-06 cargo build --release
./target/release/joystream-node -- --pruning archive --chain testnets/joy-testnet-4.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:

http://localhost:3000/?rpc=ws://localhost:9944/

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.

Integration tests

tests/network-tests/run-tests.sh

Contributing

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 eslint for code quality of our JavaScript and TypeScript code and prettier for consistent formatting. For Rust we rely on rustfmt and clippy.

The husky npm package is used to manage the project git-hooks. This is automatically installed and setup when you run yarn install.

When you 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

Authors

See the list of contributors who participated in this project.

License

All software under this project is licensed as GPLv3 unless otherwise indicated.

Acknowledgments

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.