Forked from Joystream/atlas https://github.com/Joystream/atlas
Klaudiusz Dembler
958772fb0f
Merge branch 'init_atlas' into atlas-components-merge
|
4 tahun lalu | |
|---|---|---|
| __mocks__ | 4 tahun lalu | |
| packages | 4 tahun lalu | |
| .eslintignore | 4 tahun lalu | |
| .eslintrc.js | 4 tahun lalu | |
| .gitignore | 4 tahun lalu | |
| .huskyrc | 4 tahun lalu | |
| .prettierrc | 4 tahun lalu | |
| README.md | 4 tahun lalu | |
| babel.config.json | 4 tahun lalu | |
| jest.config.js | 4 tahun lalu | |
| lerna.json | 4 tahun lalu | |
| package.json | 4 tahun lalu | |
| setupTests.js | 4 tahun lalu | |
| tsconfig.json | 4 tahun lalu | |
| yarn.lock | 4 tahun lalu |
README.md
Getting Started
After cloning the repo, run:
$ cd atlas
$ yarn install
$ yarn start
To start the app on localhost:1234, Storybook on localhost:6006 and the bundler in watch mode.
To build the app for distribution, run:
$ yarn build
To run tests (Currently WIP) run:
$ yarn test
Packages
This repo is managed with yarn workspaces
To run a command in a workspace:
$ yarn workspace YOUR_WORKSPACE_NAME YOUR_COMMAND
For example, to add react-spring to atlas-app:
$ yarn workspace atlas-app add react-spring
App package
The app package is located under ./packages/app and is where the actual Atlas application lives.
Business logic, full pages and data fetching should all reside here.
Shared folder
Historically, Atlas codebase was split between two packages - app and @joystream/components. Due to build process and developer experience issues it was decided to merge those packages into one until the separation is actually needed. Hence the shared directory under app/src. This folder is what used to be @joystream/components and it's intended to be application-agnostic. That means no Atlas-specific logic (like routing) should be put there, only atomic UI components.
Deploy Previews
Each PR has deploy previews for both for Storybook and for the App on Chromia and Netlify respectively.