forked from Joystream/pioneer
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
51 changed files
with
1,349 additions
and
497 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,40 +1,42 @@ | ||
![Pioneer](https://user-images.githubusercontent.com/247363/116713796-699da780-a9d5-11eb-82b1-a42bccd642d7.png) | ||
|
||
|
||
# Pioneer | ||
|
||
[![CI](https://github.com/Joystream/pioneer/actions/workflows/CI.yml/badge.svg)](https://github.com/Joystream/pioneer/actions/workflows/CI.yml) | ||
|
||
Governance application for the Joystream DAO platform. | ||
|
||
## Deployed version | ||
|
||
- The live production is available on [https://pioneerapp.xyz/) | ||
- Components preview and testing from `dev` branch, is available on [https://pioneer-2-storybook.vercel.app/](https://pioneer-2-storybook.vercel.app/). | ||
|
||
The deployed version can interact with two backends: | ||
|
||
- Joystream testnet β A deployed testnet. | ||
- Local β [A Joystream ecosystem running locally](docs/testenv.md). | ||
<h1 > | ||
<a href="https://pioneerapp.xyz"> | ||
<img alt="Pioneer" src="https://user-images.githubusercontent.com/247363/116713796-699da780-a9d5-11eb-82b1-a42bccd642d7.png" /> | ||
</a> | ||
</h1> | ||
|
||
<h3 align="center"> | ||
Governance application for the Joystream DAO platform. | ||
</h3> | ||
|
||
<p align="center"> | ||
<strong> | ||
<a href="https://pioneerapp.xyz">Live app</a> | ||
β’ | ||
<a href="docs/README.md">Docs</a> | ||
β’ | ||
<a href="https://pioneer-2-storybook.vercel.app">Storybook</a> | ||
</strong> | ||
</p> | ||
|
||
## Quickstart | ||
|
||
After cloning the repository run: | ||
|
||
```shell | ||
## Install npm packages | ||
yarn | ||
## Clone this repository | ||
git clone [email protected]:Joystream/pioneer.git | ||
|
||
## Build all the sub-packages | ||
yarn build | ||
cd pioneer | ||
|
||
## Install npm packages | ||
yarn --immutable | ||
|
||
## To start local development server | ||
yarn start | ||
|
||
## To start local storybook instance | ||
yarn storybook | ||
|
||
## To run tests | ||
## To run tests (the back-end tests require docker in order to run) | ||
yarn test | ||
``` | ||
|
||
|
@@ -50,9 +52,8 @@ To run a Pioneer instance check the [admin documentation](docs/admin.md) | |
|
||
The project's monorepo contains packages: | ||
|
||
- [packages/ui](packages/ui) β The main Pioneer 2.0 package | ||
- [packages/types](packages/types) β A copy of [@joystream/types](https://github.com/Joystream/joystream/tree/master/types) checked out from the `master` branch. | ||
- [packages/metadata-protobuf](packages/metadata-protobuf) β A copy [@joystream/metadata-protobuf](https://github.com/Joystream/joystream/tree/master/metadata-protobuf) checked out from an `master` branch. | ||
- [packages/ui](packages/ui) β The Pioneer front-end package. | ||
- [packages/server](packages/server) β The Pioneer backend package. | ||
- [packages/markdown-editor](packages/markdown-editor) β A CKEditor 5 build used as Markdown editor. | ||
|
||
## Contributing | ||
|
Oops, something went wrong.