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

12015 Komitmen

0 Rilis

Shamil Gadelshin a9b0c8432f runtime: Drop hiring dependencies.		4 tahun lalu
.github	0f7f8ea3c6 runtime integration tests: update from babylon	4 tahun lalu
cli	32bbfd035a do not use relative volta config for published packages	4 tahun lalu
content-directory-schemas	32bbfd035a do not use relative volta config for published packages	4 tahun lalu
devops	6b6951af79 scripts: Update rust nightly version.	4 tahun lalu
node	5f8c370bcf Merge pull request #1838 from Joystream/working_team_pallet	4 tahun lalu
pioneer	aaf5dfb343 config volta in "sub-projects" of the workspace	4 tahun lalu
query-node	8c6424f12f hydra-cli 0.0.20	4 tahun lalu
runtime	a9b0c8432f runtime: Drop hiring dependencies.	4 tahun lalu
runtime-modules	a9b0c8432f runtime: Drop hiring dependencies.	4 tahun lalu
scripts	b0f22d42d1 Merge pull request #1731 from conectado/proposals_update_engine_benchmark	4 tahun lalu
storage-node	aaf5dfb343 config volta in "sub-projects" of the workspace	4 tahun lalu
testnets	1660a22e56 add joy-testnet-4.json	4 tahun lalu
tests	c7f588542a fix some relative links to volta	4 tahun lalu
types	32bbfd035a do not use relative volta config for published packages	4 tahun lalu
utils	bc3b516c9c Remove content_config.rs, refactor chainspec	4 tahun lalu
.dockerignore	4495ae9230 docker: fix pioneer build - .dockerignore inadvertantly ignoring pioneer code	4 tahun lalu
.editorconfig	565ade3481 code style last tweaks, add format and checks yarn scripts	4 tahun lalu
.env	fa2ceae725 query-node: fix network-name	4 tahun lalu
.eslintrc.js	1a3bcbfa55 global tsconfig and .eslintrc	4 tahun lalu
.gitignore	70c39e9cb3 query-node: check in generted code	4 tahun lalu
.prettierrc.js	9da958cc1c pretty some files	4 tahun lalu
.yarnclean	643c08c7a0 Pioneer workspaces config etc.	4 tahun lalu
Cargo.lock	a9b0c8432f runtime: Drop hiring dependencies.	4 tahun lalu
Cargo.toml	3030a47218 Merge branch 'olympia' into working_team_olympia_merge2	4 tahun lalu
LICENSE	248dcb5c30 README	4 tahun lalu
README.md	727413852f Merge branch 'docker/unified-docker-compose' into runtime_upgrade_ci_and_build_update	4 tahun lalu
apps.Dockerfile	4495ae9230 docker: fix pioneer build - .dockerignore inadvertantly ignoring pioneer code	4 tahun lalu
build.sh	ddf2e62e37 build.sh: native binaries as last step	4 tahun lalu
docker-compose.yml	d312b7b894 docker-compose: all services listen on localhost	4 tahun lalu
joystream-node.Dockerfile	91d4108ec4 update setup and docker image to use rust 1.47.0, and nightly-2020-10-06 for WASM	4 tahun lalu
package.json	4e40d88376 update build, setup and start scripts	4 tahun lalu
setup.sh	91d4108ec4 update setup and docker image to use rust 1.47.0, and nightly-2020-10-06 for WASM	4 tahun lalu
start.sh	547b64d070 start scripts forgot to bring up graphql-server	4 tahun lalu
tsconfig.json	7e97ac9cff Revert "dropped parserOptions.project array from pioneer/.eslintrc.js"	4 tahun lalu
yarn.lock	8c6424f12f hydra-cli 0.0.20	4 tahun lalu

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.

Build Status

Development - build history on Travis

Development Tools

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

# run some tests
yarn cargo-checks

Software

Substrate blockchain

Server Applications - infrastructure

Storage Node - Media Storage Infrastructure
Query Node - under development
Discovery Node - under development

Front-end Applications

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

Tools and CLI

joystream-cli - CLI for community and governance activities

Testing infrastructure

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

README.md