JoystreamStats 2e547e1882 remove FM banner | há 2 anos atrás | |
---|---|---|
.. | ||
.storybook | há 4 anos atrás | |
docker | há 4 anos atrás | |
img | há 4 anos atrás | |
packages | há 2 anos atrás | |
scripts | há 4 anos atrás | |
test | há 3 anos atrás | |
.123trigger | há 4 anos atrás | |
.babelrc.js | há 4 anos atrás | |
.codeclimate.yml | há 4 anos atrás | |
.dockerignore | há 4 anos atrás | |
.editorconfig | há 4 anos atrás | |
.env-example | há 4 anos atrás | |
.eslintignore | há 4 anos atrás | |
.eslintrc.js | há 4 anos atrás | |
.gitignore | há 4 anos atrás | |
.gitlab-ci.yml | há 4 anos atrás | |
.npmignore | há 4 anos atrás | |
.nvmrc | há 4 anos atrás | |
.prettierignore | há 4 anos atrás | |
.stylelintrc | há 4 anos atrás | |
.travis.yml | há 4 anos atrás | |
BOUNTIES.md | há 4 anos atrás | |
CHANGELOG.md | há 4 anos atrás | |
CONTRIBUTING.md | há 4 anos atrás | |
Dockerfile | há 4 anos atrás | |
I18N.md | há 4 anos atrás | |
LICENSE | há 4 anos atrás | |
README.md | há 3 anos atrás | |
babel.config.js | há 4 anos atrás | |
deployment.extras.yml | há 4 anos atrás | |
deployment.template.yml | há 4 anos atrás | |
env.sh | há 4 anos atrás | |
gh-pages-refresh.sh | há 4 anos atrás | |
i18next-scanner.config.js | há 4 anos atrás | |
jest.config.js | há 4 anos atrás | |
lerna.json | há 4 anos atrás | |
package.json | há 3 anos atrás | |
tsconfig.json | há 3 anos atrás | |
tsfmt.json | há 4 anos atrás | |
types.json | há 4 anos atrás |
A Portal into the Joystream network. Provides a view and interaction layer from a browser.
This can be accessed as a hosted application via https://testnet.joystream.org.
The repo is split into a number of packages, each representing an application. These are -
In addition the following libraries are also included in the repo. These are to be moved to the @polkadot/ui repository once it reaches a base level of stability and usability. (At this point with the framework being tested on the apps above, it makes development easier having it close)
Contributions are welcome!
To start off, this repo (along with others in the @polkadot family) uses yarn workspaces to organise the code. As such, after cloning dependencies should be installed via yarn
, not via npm, the latter will result in broken dependencies.
To get started -
git clone https://github.com/joystream/joystream <optional local path>
yarn
yarn run start
There is a StoryBook implementation, the UI for which can be started with yarn storybook
and then accessed in a browser via http://localhost:3001 (and the server will open a new browser tab by default when it starts).
Story code can be placed anywhere in the packages
directory, and will be detected as long as the file name ends in `.stories.tsx. Stories should be defined in the Component Story Format (CSF) for consistency.
There are several StoryBook addons available, the most useful of which is Knobs, which allows props to be altered in real time.
Note that currently StoryBook only allows for stateless components; it has no connection to polkadot.js or any Substrate node. This means that existing components, which are often tightly coupled with the Polkadot API, cannot be used in storybook.