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

Mokhtar Naamani f662b6fdda query-node: clean build 4 жил өмнө
.github b5b6997dfb Merge pull request #1639 from mnaamani/query-node/ignore-generated-code 4 жил өмнө
cli 4666ac7f8c Merge pull request #1614 from Lezek123/cli-babylon-remaining 4 жил өмнө
content-directory-schemas bf9594c7af TS SimpleEntityValue fix 4 жил өмнө
devops 0018fc6575 storage-node: remove initialization of old versioned store from dev-init and bump types 4 жил өмнө
node f4a29f1e5d runtime: Add migration for the content working group. 4 жил өмнө
pioneer 8012c9d7f1 Change default page 4 жил өмнө
query-node f662b6fdda query-node: clean build 4 жил өмнө
runtime f4a29f1e5d runtime: Add migration for the content working group. 4 жил өмнө
runtime-modules 6d124e1d23 Merge pull request #1599 from shamil-gadelshin/content_directory_migration 4 жил өмнө
scripts d9c68d3e12 workflows: push also caches joystream-node image 4 жил өмнө
storage-node 819c2049e6 storage-node integration tests: retry on wait for ipfs registration 4 жил өмнө
testnets 1660a22e56 add joy-testnet-4.json 4 жил өмнө
tests f2cd56410e query-node: update tests workflow 4 жил өмнө
types 2b9affa320 InputParser - helper for addSchemaSupportToEntity and updateEntityPropertyValues (+ example) 4 жил өмнө
utils 3c6ee2a2a0 api-scripts: use patched WsProvider to be able to do runtime upgrade 4 жил өмнө
.dockerignore f662b6fdda query-node: clean build 4 жил өмнө
.editorconfig 565ade3481 code style last tweaks, add format and checks yarn scripts 4 жил өмнө
.eslintrc.js 1a3bcbfa55 global tsconfig and .eslintrc 4 жил өмнө
.gitignore 70c39e9cb3 query-node: check in generted code 4 жил өмнө
.prettierrc.js 9da958cc1c pretty some files 4 жил өмнө
.yarnclean 643c08c7a0 Pioneer workspaces config etc. 4 жил өмнө
Cargo.lock f4a29f1e5d runtime: Add migration for the content working group. 4 жил өмнө
Cargo.toml c71d8204f3 Merge branch 'content_directory_second_try' into iznik 4 жил өмнө
LICENSE 248dcb5c30 README 4 жил өмнө
README.md a29301f125 network-tests: run worker tests for all working groups, log runtime output on exit 4 жил өмнө
apps.Dockerfile ea241cf9f7 query-node: fix build scripts and remove generated code from yarn workspace 4 жил өмнө
docker-compose-with-storage.yml 153fe8db9c Merge branch 'babylon' into docker-apps 4 жил өмнө
docker-compose.yml de51bf6ed1 network-tests: run tests for all workgroups 4 жил өмнө
joystream-node.Dockerfile e67d2d0679 fix joystream-node.Dockerfile 4 жил өмнө
package.json 381418bd8a query-node: update to @dzlzv/hydra-indexer-lib@0.0.19-legacy.1.26.1 4 жил өмнө
rust-builder.Dockerfile 18a0ccf514 refactoring: relocating Dockerfiles and compose files, removed ansible scripts 4 жил өмнө
setup.sh da3243fa0a build scripts: use correct rust nightly toolchain 4 жил өмнө
tsconfig.json 7e97ac9cff Revert "dropped parserOptions.project array from pioneer/.eslintrc.js" 4 жил өмнө
yarn.lock f662b6fdda query-node: clean build 4 жил өмнө

README.md

Joystream Build Status

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 Development Branch Build Status - build history on Travis

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-05-23 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

docker-compose up -d
DEBUG=* yarn workspace network-tests test-run src/scenarios/full.ts
docker-compose down

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.