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

Ricardo Maltez c2247c41d0 Code improvements suggested by @DzhideX před 3 roky
.github 68f297a9af Merge pull request #2550 from ahhda/update-ansible-core před 3 roky
cli 70bdbcdfe5 cli: README před 3 roky
content-metadata-protobuf 0804bfbb34 Fix checks - remove StorageProviderRecord and run formatter on protobuf library před 3 roky
devops f6205c2b54 Update README před 3 roky
node 90ab4c2063 runtime: fix unstaking from operations and gateway working groups před 3 roky
pioneer c2247c41d0 Code improvements suggested by @DzhideX před 3 roky
query-node f801dea4ea query node - .env file cleaning před 3 roky
runtime dac89e7bbc runtime: remove commented Executive code před 3 roky
runtime-modules 90ab4c2063 runtime: fix unstaking from operations and gateway working groups před 3 roky
scripts f7e53e4dba rust nightly-2021-03-24 před 3 roky
storage-node 198d45a7f4 storage-node: allow 4s to stat local file before considering it not available locally před 3 roky
testnets 5524c31b89 add antioch chainspec file před 3 roky
tests 5a420fc766 drop unnecessary typecast to SubmittableExtrinsic<'promise'> před 3 roky
types aaeb89561a add @polkadot/metadata to package.json resolutions and rebuild augment types před 3 roky
utils 20653d141d @joystream/types v0.16.1 před 3 roky
.dockerignore 470fe5be9f Add option to include production parameters to colossus před 3 roky
.editorconfig 565ade3481 code style last tweaks, add format and checks yarn scripts před 4 roky
.env 716d9eb835 github workflow start joystream-node before running query-node tests před 3 roky
.eslintrc.js 1a3bcbfa55 global tsconfig and .eslintrc před 4 roky
.gitignore f7cb4b976a spec-builder: upgrade to v2.0.0 před 3 roky
.prettierrc.js 9da958cc1c pretty some files před 4 roky
.yarnclean 643c08c7a0 Pioneer workspaces config etc. před 4 roky
Cargo.lock 90ab4c2063 runtime: fix unstaking from operations and gateway working groups před 3 roky
Cargo.toml 8768c1bebf runtime and types: drop service_discovery module před 3 roky
LICENSE 248dcb5c30 README před 4 roky
README.md 5524c31b89 add antioch chainspec file před 3 roky
apps.Dockerfile e7b385e7e1 Add platform to apps.Dockerfile před 3 roky
build-docker-images.sh 8732afe6db drop old build.sh and re-fix typo před 3 roky
build-npm-packages.sh 232282f617 Remove CLI build workaround před 3 roky
colossus.Dockerfile 67d258b573 Update README, remove custom containers před 3 roky
docker-compose.yml a0f037baab update joystream/hydra-indexer:2.1.0-beta.9 před 3 roky
joystream-node.Dockerfile 853570c0f7 use lighter final ubuntu image for joystream-node před 3 roky
package.json ca5e6b45dd query node - *Connection entities ordering consistency fix před 3 roky
pioneer.Dockerfile 72229f792b nodejs 14 před 3 roky
setup.sh 853570c0f7 use lighter final ubuntu image for joystream-node před 3 roky
start.sh dc47ff2183 api-scripts: add helper script to make sudo the membership screening authority před 3 roky
tsconfig.json 7e97ac9cff Revert "dropped parserOptions.project array from pioneer/.eslintrc.js" před 4 roky
yarn.lock 27dfe5a50b query node - graphql playground settings + reenabling relation id fields před 3 roky

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, build packages and docker images
yarn build

# start a local development network
yarn start

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 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:

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.