This app is...
It is for...
Where possible, pull requests should be reviewed by the owner.
- Nick Johnson
- https://github.com/nicholas-johnson
- nicholas@beamery.com
This section lets future devs know how to organise code in this app. In theory it stops the app from becoming a patchwork of overlapping styles, patterns and libraries.
Include a brief overview of your philosophy and design considerations. Include things like whether or not your components are stateless, if you have to make any compromises for third-party integrations, if you have used anything other than a React/Redux standard stack, etc?
Mention any funky organisational strategies like atomic design.
Include things like file structure, technologies used, whether you are using recompose, hooks, maybe something else.
How have you organised your flux store? How do you flow state through the app? Do you have some stateful components? Which ones and why? Are you storing all state in the store? Do you use context?
Effects? Sagas? etc. How do you hit the API?
How are you styling your app? How is the styling isolated from other apps?
Is there anything in this app that doesn't fit the standard pattern? Where do you put it?
Anything else you need to cover?
How do I get set for development? How do I start in standalone mode?
Start webpack in watch mode with:
beam app start yourapp
or
npm start
npm start:independent
View the running app at:
npm test
Linting is based on AirBnB. Lint with:
npm run-script lint
Please be sure to have eslint and editorconfig plugins installed in your editor.
Before issuing a PR, be sure to run tests and the linter:
npm test
npm run-script lint
Please respect Husky. Don't push code that fails to pass the tests. Don't use --no-verify, or ants will eat you in the night.
If you wish to refactor this app, please refactor it in it's entirety. Don't create a patchwork. Ensure all tests continue to run. Update the philosophy section in this app, so future devs can understand your design decisions.
If you're working on this app or issuing a pull request, please let the maintainer know. Ideally all PRs should be seen and approved by the repo owner. If this is not possible, please respect the rules set out in the philosophy section.