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

Klaudiusz Dembler e82cf71f27 add graphql/miragejs data fetching 4 rokov pred
packages e82cf71f27 add graphql/miragejs data fetching 4 rokov pred
.eslintignore 958772fb0f Merge branch 'init_atlas' into atlas-components-merge 4 rokov pred
.eslintrc.js 57dad754b8 rework video player 4 rokov pred
.gitignore 958772fb0f Merge branch 'init_atlas' into atlas-components-merge 4 rokov pred
.huskyrc cfb3da0073 Add 'atlas/' from commit 'b0d9e86372a8f70ca70f8fd616c52c857ac39a2a' 4 rokov pred
.prettierignore 5383e74f61 fix prettier issues 4 rokov pred
.prettierrc.js 5383e74f61 fix prettier issues 4 rokov pred
README.md d62854edf7 update readme 4 rokov pred
lerna.json 5383e74f61 fix prettier issues 4 rokov pred
package.json 5aff1b3ee1 fix linting errors 4 rokov pred
tsconfig.json 5383e74f61 fix prettier issues 4 rokov pred
yarn.lock e82cf71f27 add graphql/miragejs data fetching 4 rokov pred

README.md

Getting Started

After cloning the repo, run:

$ cd atlas
$ yarn install
$ yarn start

To start the app on localhost:3000, 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.