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

Klaudiusz Dembler 8ccd687042 MR fixes 4 年之前
packages 8ccd687042 MR fixes 4 年之前
.eslintrc.js 6bbedd69e0 Add Style Reducer And Small Button Refactor 4 年之前
.gitignore 562163d23e Add Chromia And Partial Jest Setup 4 年之前
.huskyrc cfb3da0073 Add 'atlas/' from commit 'b0d9e86372a8f70ca70f8fd616c52c857ac39a2a' 4 年之前
.prettierrc 6bbedd69e0 Add Style Reducer And Small Button Refactor 4 年之前
README.md b81a2c04f8 move @joystream/components into atlas app, clean up build process 4 年之前
babel.config.json 8ccd687042 MR fixes 4 年之前
jest.config.js c0e13fa123 Make Travis Run Iff Rust Files Have Been Changed 4 年之前
lerna.json cfb3da0073 Add 'atlas/' from commit 'b0d9e86372a8f70ca70f8fd616c52c857ac39a2a' 4 年之前
package.json 8ccd687042 MR fixes 4 年之前
setupTests.js c0e13fa123 Make Travis Run Iff Rust Files Have Been Changed 4 年之前
tsconfig.json b81a2c04f8 move @joystream/components into atlas app, clean up build process 4 年之前
yarn.lock b81a2c04f8 move @joystream/components into atlas app, clean up build process 4 年之前

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.