Clone this repository. Run yarn to install all dependencies, then
yarn start
This project was bootstrapped with Create React App.
See its README for details.
Prettier is installed as a pre-commit hook.
All staged code is formatted on commit according to the configuration defined in the .prettierrc file.
Install a prettier extension in your IDE to also format directly from there.
Install an eslint plugin in your IDE to visualize lint errors before they appear in console.
flow is configured in the project. Add:
// @flow
at the beginning of all JS files to enable type checking.
Install a flow extension in your IDE and make sure to add types when requested.
Refrain from using any and do not commit code with flow errors.
Storybook is used to develop and test components in isolation. Start it using:
yarn storybook
Create stories for all dumb components, with nominal and limit cases. For MyComponent.js, create an associated MyComponent.stories.js file, located next to it.
Test files have a .test.js extension. They should be located next to the main file they exercise.
Run all tests (by default only those affected by your changes since the last commit) using:
yarn test