Git Product home page Git Product logo

joystream-old-website's Introduction

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 the substrate blockchain framework, and adds additional functionality to support the various roles that can be entered into on the platform.

Development

For best results use GNU/Linux with minimum glibc version 2.28 for nodejs v18 to work. So Ubuntu 20.04 or newer.

You can check your version of glibc with ldd --version

The following tools are required for building, testing and contributing to this repo:

  • Rust toolchain - required
  • nodejs >= v14.18.x - required (However volta will try to use v18.6)
  • yarn classic package manager v1.22.x- required
  • docker and docker-compose v2.20.x or higher - required
  • 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 to get started:

Install development tools

./setup.sh

If you prefer your own node version manager

Install development tools without Volta version manager.

./setup.sh --no-volta

For older operating systems which don't support node 18

Modify the root package.json and change volta section to use node version 16.20.1 instead of 18.6.0

"volta": {
    "node": "16.20.1",
    "yarn": "1.22.19"
}

Run local development network

# Build local npm packages
yarn build

# Build joystream/node docker testing image
RUNTIME_PROFILE=TESTING 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-2022-11-15 cargo build --release
./target/release/joystream-node -- --pruning archive --chain joy-mainnet.json

Learn more about joystream-node.

A step by step guide to setup a full node and validator on the Joystream main network, can be found here.

Pre-built joystream-node binaries

Look under the 'Assets' section:

Mainnet chainspec file

Integration tests

# Make sure yarn packages are built
yarn build

# Build the test joystream-node
RUNTIME_PROFILE=TESTING yarn build:node:docker

# Run tests
yarn test

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.

joystream-old-website's People

Contributors

bedeho avatar bwhm avatar marianorod avatar mnaamani avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

joystream-old-website's Issues

Fix broken sectino links

When you navigate to a section, e.g. using https://www.joystream.org/roles#Bandwidth-Provider, you get

Screenshot 2019-05-08 at 12 14 51

However, it would be much better if you also caught the full title, like this

Screenshot 2019-05-08 at 12 14 59

Token page

Background

The joystream platform has two different kinds of tokens. In order to further clarify how the system will likely work at the launch of the main network, it would be a benefit to explain key aspects of both token types.

The platform token

Description: This is the main token on the platform, and it is called the JOY token. It is minted over time to pay anyone who contributes value to the system, such as validators, service providser and workers.

Purpose:

  • Staking: Participants must stake some amount of this token to be able to participate on the platform in some operational role, for example in order to earn a reward. The staked funds may be slashed if the party misbehaves
  • Governance:
  • Payment: Value transfer, such as for transaction fees, memberships or accessing monetised content.

Allocation:

The initial allocaiton of this token in the main network launch is as given below.This means that when the system starts, the allocation of token will first look like this, but tokens will get minted on every block, which will dilute this set of stakeholders.

  • 50% team+investors
  • 20% early community members
  • 30% unallocated.

Aquisition:

The only way to currently aquire the token is to participate on the platform when it is live.

Issuance schedule:

Unlike coins like Bitcoin, where there is a fixed inflatin schedule, the Joystream platform will mint and burn tokens according to rules an parameters which are subject to change. This, in combination with the low friction updating of the system rules, means that it is not possible to determine the token supply up front.

Creator tokens

Description:

Proposal

Lets create a new standalone page, called the "Token" page, accessible via the website navigation

Use illustration for joystream tokens from network state.

Fotter with legal disclaier

Add explainer section on main page

We need to first define goals for this, not clear.

This is a complex challenge, but it would be worth trying it again. There are many things we may want to communicate, and perhaps we must prioritize, or move something out. It could cover things like

  1. What the project is trying to do.
  2. The way the project will evolve and go live.
  3. What you can do now, some how tying in the

Capture email addresses from Roles section

Ref #20:
We need a GDPR complaint yet smooth way of having people sign up for mailchimp lists targeting each role.
For the inactive roles, the current design looks like this:
image
For the active roles, it looks like this:
image


Inactive roles

  1. As is the case for Active roles today, there should be a link to Rocket.Chat/Telegram (ask a question)
  2. Remove the button saying “Send me a notification” (or at least make it non-clickable)
  3. Either when someone clicks the email input field, or when someone starts typing, the field below should expand and show some extra information.
    a. A button to check, accompanied by
    b. A text field saying “Yes, I want to receive emails with updates on the status regarding the role.”
    c. Below this:
    We use Mailchimp as our marketing platform. By clicking below to subscribe, you acknowledge that your information will be transferred to Mailchimp for processing. Learn more about Mailchimp's privacy practices here.
    d. Finally, a button saying “Sign me up”. (Or make it clickable if the checkbox has been checked)
    image
  4. When the information is submitted, The whole field should be replaced by a text field (and maybe an illustration?) saying:

Subscription Confirmed

Your subscription to our mailing list of people interested in receiving information and updates about the role has been confirmed. Thank your for subscribing!
If you want to interact with us, or other people interested in this role, go to Telegram/RocketChat.
For questions about this list, contact [email protected]
Jsgenesis AS
C/O UMA Workspace
Stenersgata 8
0184 Oslo
Norway


Active roles

In addition to the current buttons, we would also like for users to be able to sign up for lists with news/updates. It should be the same process as for Inactive roles, but still clear that they can indeed take this role on testnet today.


Summary

Feel free to play around how to exactly arrange this, but the final site must have the features described here. As we are using mailchimp, we may need someone to do some work in there as well.

WIP: New About section+page

What to include?

  • Core jsgenesis team members: short bio + illustration head shot. ?
  • Key backers ?
  • How could we try to include community more into this page? Key Tg, Github, Testnet contributors?

Automate stat updates on website

  • Memberships
  • Platform Content Files
  • Participation Payouts

For Acropolis

  • Forum Posts
  • Storage Providers (not really relevant before)

Standardised testnet exposition

Background

As the testnets become ever more complicated, with more active roles and metrics worth tracking it's going to become impractical to keep that all on the main page. We will need to add new supporting information we are currently not presenting, such as links to specifications, all tutorials, goals for the release, explanation of branding, etc.

Proposal

For each testnet, let's have a single concise standalone URL, e.g. joystream.org/<testnet-name>, for each testnet. On the front page we have a standardised summary of the

  • currently active network
  • currently announced next network

each should link to the standalone page of the corresponding network.

Standalone page

Read more on network branding here

  • Name of network
  • Network logo: should be prominent
  • Description of city: max 100 words
  • Photo of map showing where city is located, with date.
  • Goal for network: max 150 words
  • Status: announced (blue?), live (green?), down (red?) or done (grey?)
  • Milestones: a sequence of goals of major goals, and for each show completion status (achieved, not achieved)
  • Unlocked Roles: list of new roles unlocked in this network
  • Active Roles: list of all roles that are active on this network
  • Button linking to specification: if there is no specification, or if it is not yet live, then this button should be greyed out.
  • Button linking to release document: if its not live yet, then this button should be greyed out.

Beyond this, there is some conditionality in what is shown, depending on the status of the network.

  1. announced
    There should be an expected launch date with very prominent count down clock

  2. live
    Will vary from network to network, but the basic approach will be to have to separate out each subsystem, like the council or the storage system for example, of the platform into its own visual section, where that section shows relevant information and metrics for it, so for validators, it would for example show

  • The number of active validators
  • the number of pending validators
  • The number of blocks produced
  • The total amount of reward payments we have paid out

Ideally, no clicking required to consume the information.

  1. down
    Show some large error message, max 40 words, we can specify, which explains why the network is done and what we are doing about it.

  2. done
    Show large message saying that something like, The X network is no longer live

Currently active network section

Again, this is on the main page, and includes

  • name of network
  • logomark of network
  • a short summary of live status metrics
  • button linking to the standalone page
  • button linking to the announcement blog post

Announced next network section

Again, this is on the main page.

  • name of network
  • logomark of network
  • large countdown timer to release date
  • clickable button linking to the standalone page

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.