This React based webapp leverages several frameworks/libraries (not an exhaustive list):
- React • Declarative UI component library
- Redux • Global application state management
- Redux-Saga • Asynchronous side-effect management
- Styled Components • Component styling library
- Lodash • JS utility function library
- Jest • JS testing framework
- Enzyme • JS testing utility
These are all the pertinent scripts for running the application locally. I prefer to use yarn but you can replace it in all of the following instructions with npm without issue.
Will install all required NPM packages.
yarn install
Starts a development server at http://localhost:3000 and will live-replace any code changes w/o requiring page reload.
yarn dev
This parses all test files and runs them. It should also generate a coverage report.
NOTE: The end-to-end tests will need a browser environment in order to run. You will need to have a development server running concurrently (see above) in order for those tests to run.
yarn test
Generates the static, minified assets needed to deploy the application live. All assets are dumped into the dist folder at the root of the project.
yarn build
This command runs the tests and if sucessful, will build the production assets and push them to GitHub Pages
yarn deploy
Will prompt you with a short series of questions in order to generate new component modules in the codebase (saves on some repetitive scaffolding)
yarn generate