Skip to content

Latest commit

 

History

History
80 lines (48 loc) · 3.45 KB

README.md

File metadata and controls

80 lines (48 loc) · 3.45 KB

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn format

Runs automated code formatting on all applicable file types.

yarn lint

Lints all applicable files and prints the output.

yarn compile

Dry-runs the TypeScript compiler. This is especially useful to check whether any types or references broke after a big refactoring.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn storybook

Launches Storybook.

Stories are automatically added from all *.stories.tsx files.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

yarn eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Folder Structure

First off: All files and directories should be named in lowerCamelCase.ts. The only exception are some-package-name.d.ts files specifying typings for npm packages. There is no exception in casing for files holding a component.

The project is structured in the following way:

  • .storybook/: Storybook config
  • public/: Static files copied over to the build
  • src/: Application source
    • app/: The app's entry point
    • components/: Components that do not hook into the application store
    • i18n/: Internationalization config and translations
    • lib/: Application-independent library code that could later be extracted into its own package
    • models/: mobx-state-tree models
    • screens/: All screens accessible via their own route
    • stories/: Leave as is, holds configuration for storyshot tests
    • theme/: Shared SCSS like commonly used colors, etc.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.