clone project into $directory
cd into $directory
nvm use to ensure the correct version of node and npm are being used
Node/npm version: lts/dubnium
- Run
npm installto install required dependencies - Run
npm run build:developmentto build for development - Navigate to http://localhost:8080/ in your browser
- Modify and save /src/ files to hot load changes
In the project directory, you can run:
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.
Builds the app for development to the dist folder.
It correctly bundles React in devlopment mode.
Builds the app for development to the dist folder.
It correctly bundles React in devlopment 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.
Runs npm run lint:js && npm run lint:css which lints all files in the projects.
Runs entire test suite. See testing section for more information
Updates jest snapshots. Only use this after you've ensured that the updates that will be made are actually needed and intended
This project should be unit tested. To run tests run npm run test which will run all tests using Jest in the /tests/ directory.
This project is using Jest for the testing Framework, and enzyme for the react rendering framework. jestconfig.json and jestsetup.js is where config and setup are handled for jest.
To view coverage after running tests open tests/jest/reports/coverage/index.html in a browser. At the very least try to keep coverage > 80%
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Ensure tests are updated and passing. Ensure you introduced no new linting errors or warnings without reason.