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

Mokhtar Naamani 131a7fa022 bump runtime 3 år sedan
.github 097a646ed2 update build and ci scripts to use runtime_profile feature 3 år sedan
.pipelines 097a646ed2 update build and ci scripts to use runtime_profile feature 3 år sedan
analyses 0ebede74df Forum: runtime changes to support thread labels/tags 3 år sedan
cli 4773c32e4f update remaining schemas 3 år sedan
devops fa0acbbf01 add playground runtime profile 3 år sedan
distributor-node 4773c32e4f update remaining schemas 3 år sedan
metadata-protobuf 08d8408796 Add `WorkingGroupOpeningMetadata.title` 3 år sedan
node 131a7fa022 bump runtime 3 år sedan
query-node 9b9c17d463 fix merge conflict issue after merge from master 3 år sedan
runtime 131a7fa022 bump runtime 3 år sedan
runtime-modules b65fc9e1ca Merge remote-tracking branch 'upstream/olympia' into qn-remove-call-dependency 3 år sedan
scripts fa0acbbf01 add playground runtime profile 3 år sedan
storage-node 4773c32e4f update remaining schemas 3 år sedan
testnets 5524c31b89 add antioch chainspec file 3 år sedan
tests 5a803bc879 update testing parameters 3 år sedan
types 916a10213e types v0.18.2 3 år sedan
utils 131a7fa022 bump runtime 3 år sedan
.dockerignore 1e546843f2 integration-tests > network-tests 3 år sedan
.editorconfig 565ade3481 code style last tweaks, add format and checks yarn scripts 4 år sedan
.env 4f0cbd4fd0 test scenarios load both test config .env and root .env 3 år sedan
.eslintrc.js 1a3bcbfa55 global tsconfig and .eslintrc 4 år sedan
.gitignore 70d77a8fa0 Add additional shasum conditions, add artifact dir 3 år sedan
.prettierrc.js 9da958cc1c pretty some files 4 år sedan
.yarnclean 643c08c7a0 Pioneer workspaces config etc. 4 år sedan
Cargo.lock 131a7fa022 bump runtime 3 år sedan
Cargo.toml b02d986c84 runtime: Delete memo pallet. 3 år sedan
LICENSE 248dcb5c30 README 4 år sedan
README.md fa0acbbf01 add playground runtime profile 3 år sedan
apps.Dockerfile 23a386b098 Remove Pioneer 3 år sedan
build-node-docker.sh fa0acbbf01 add playground runtime profile 3 år sedan
build-packages.sh 8cd0d2d850 Merge branch 'giza_feature_NewContentFeaturesAndNFT' into olympia 3 år sedan
chain-metadata.json b65fc9e1ca Merge remote-tracking branch 'upstream/olympia' into qn-remove-call-dependency 3 år sedan
colossus.Dockerfile 2d8324c18d Merge branch 'giza_staging' into distributor-node-staging 3 år sedan
distributor-node.Dockerfile d3e0d343b5 distributor-node: converge on single config file 3 år sedan
docker-compose.yml eed7113bbf Merge branch 'giza_graphql_playground_fix' into olympia_graphql_playground_fix 3 år sedan
joystream-node-armv7.Dockerfile dfa510bec1 rollback to rust nightly-2021-02-20 3 år sedan
joystream-node.Dockerfile b50a6a4c3c implement runtime profile conditional compilation 3 år sedan
package.json eed7113bbf Merge branch 'giza_graphql_playground_fix' into olympia_graphql_playground_fix 3 år sedan
reproduce-giza-issue.sh bbf184122c Fix typo 3 år sedan
setup.sh 26697049a6 Merge branch 'build-node-docker-improved' into olympia-playground 3 år sedan
start.sh 4f0cbd4fd0 test scenarios load both test config .env and root .env 3 år sedan
storage-playground-config.sh 89fdd47491 Integration tests: Initial update (key management, setupNewChain), fix start.sh script 3 år sedan
tsconfig.json 7e97ac9cff Revert "dropped parserOptions.project array from pioneer/.eslintrc.js" 4 år sedan
yarn.lock ad50547010 query node - graphql playground fix and query templates V 3 år sedan

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
RUNTIME_PROFILE=TESTING yarn build:node:docker

# Run tests
./tests/network-tests/run-full-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.