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

Mokhtar Naamani 4e1ea0fd84 adding a note about test parameters in tests .env 3 rokov pred
.github 0c140543ce more accurate task descriptions 3 rokov pred
.pipelines 161c428396 update deployment ssh key 3 rokov pred
analyses 0ebede74df Forum: runtime changes to support thread labels/tags 3 rokov pred
cli 08d8408796 Add `WorkingGroupOpeningMetadata.title` 3 rokov pred
devops 0c140543ce more accurate task descriptions 3 rokov pred
distributor-node 916a10213e types v0.18.2 3 rokov pred
metadata-protobuf 08d8408796 Add `WorkingGroupOpeningMetadata.title` 3 rokov pred
node cac062b740 olympia bump spec version to 3 3 rokov pred
query-node 9541ad7c9a Merge pull request #3386 from thesan/olympia-add-opening-title 3 rokov pred
runtime cac062b740 olympia bump spec version to 3 3 rokov pred
runtime-modules 33e403f3db Merge pull request #3370 from bwhm/bwhm-olympia-staging 3 rokov pred
scripts dda5ff9f04 do not build with benchmark feature flag 3 rokov pred
storage-node 916a10213e types v0.18.2 3 rokov pred
testnets 5524c31b89 add antioch chainspec file 3 rokov pred
tests 4e1ea0fd84 adding a note about test parameters in tests .env 3 rokov pred
types 916a10213e types v0.18.2 3 rokov pred
utils 673be9bd92 Merge pull request #3364 from mnaamani/olympia-bump-types-version 3 rokov pred
.dockerignore 1e546843f2 integration-tests > network-tests 3 rokov pred
.editorconfig 565ade3481 code style last tweaks, add format and checks yarn scripts 4 rokov pred
.env 4f0cbd4fd0 test scenarios load both test config .env and root .env 3 rokov pred
.eslintrc.js 1a3bcbfa55 global tsconfig and .eslintrc 4 rokov pred
.gitignore 70d77a8fa0 Add additional shasum conditions, add artifact dir 3 rokov pred
.prettierrc.js 9da958cc1c pretty some files 4 rokov pred
.yarnclean 643c08c7a0 Pioneer workspaces config etc. 4 rokov pred
Cargo.lock cac062b740 olympia bump spec version to 3 3 rokov pred
Cargo.toml b02d986c84 runtime: Delete memo pallet. 3 rokov pred
LICENSE 248dcb5c30 README 4 rokov pred
README.md 1e546843f2 integration-tests > network-tests 3 rokov pred
apps.Dockerfile 23a386b098 Remove Pioneer 3 rokov pred
build-node-docker.sh 9178ccb1a7 pass ALL_PROPOSALS_PARAMETERS_JSON as build arg to dockerfile 3 rokov pred
build-packages.sh 8cd0d2d850 Merge branch 'giza_feature_NewContentFeaturesAndNFT' into olympia 3 rokov pred
chain-metadata.json f23d000b3b update chain-metadata json file 3 rokov pred
colossus.Dockerfile 2d8324c18d Merge branch 'giza_staging' into distributor-node-staging 3 rokov pred
distributor-node.Dockerfile d3e0d343b5 distributor-node: converge on single config file 3 rokov pred
docker-compose.yml eed7113bbf Merge branch 'giza_graphql_playground_fix' into olympia_graphql_playground_fix 3 rokov pred
joystream-node-armv7.Dockerfile dfa510bec1 rollback to rust nightly-2021-02-20 3 rokov pred
joystream-node.Dockerfile 97f6e45095 Merge branch 'olympia' into olympia-playground 3 rokov pred
package.json eed7113bbf Merge branch 'giza_graphql_playground_fix' into olympia_graphql_playground_fix 3 rokov pred
reproduce-giza-issue.sh bbf184122c Fix typo 3 rokov pred
setup.sh 26697049a6 Merge branch 'build-node-docker-improved' into olympia-playground 3 rokov pred
start.sh 4f0cbd4fd0 test scenarios load both test config .env and root .env 3 rokov pred
storage-playground-config.sh 89fdd47491 Integration tests: Initial update (key management, setupNewChain), fix start.sh script 3 rokov pred
tsconfig.json 7e97ac9cff Revert "dropped parserOptions.project array from pioneer/.eslintrc.js" 4 rokov pred
yarn.lock ad50547010 query node - graphql playground fix and query templates V 3 rokov pred

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

# build local npm packages
yarn build:packages

# Build joystream/node docker image
yarn build:node:docker

# start a local development network
yarn start

Software

Substrate blockchain

Server Applications - infrastructure

Front-end Applications

  • Pioneer v2 - Main UI for accessing Joystream community and governance features
  • Atlas - Media Player

Tools and CLI

Testing infrastructure

Running a local full node

git checkout master
WASM_BUILD_TOOLCHAIN=nightly-2021-02-20 cargo +nightly-2021-02-20 build --release
./target/release/joystream-node -- --pruning archive --chain testnets/joy-testnet-5.json

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

# Make sure yarn packages are built
yarn build:packages

# Build the test joystream-node
TEST_NODE=true yarn build:node:docker

# Run tests
./query-node/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.