This project requires Node >=12.8 and npm >=6.X You should install node using nvm.
npm installto grab all the goodies
npm run devto start a hot-reloading development server
Other useful commands:
npm testto run the tests
npm run tddto continuously run tests as you code
npm run lintto check your changes against the linting guidelines
Note about HTTPS and the development server: the development server uses a self-signed SSL certificate. When you open the development server for the first time it will squawk about the certificate being invalid. The certificate is not invalid or insecure, it is just self-signed.
Branches and Versioning
master is considered "hot" and is continously deployed to production.
NOTE: The master branch previously was deployed to a staging server, and tagged versions were deployed. However, in the React upgrade, this added step seems to have been broken. Ideally, this should be reimplemented such that only tagged commits are deployed to the live website.
Day-to-day development is done on the
develop branch. The
develop branch is continuously deployed to a development server for evaluation.
The development promotion workflow is as such:
- Work on a feature branch
- Pull request the
developbranch is merged into master when ready
This project is semantically versioned. Changes that break compatibility with the remote API are considered breaking changes.
When in doubt: delete the node modules folder and npm install again.
rm -rf node_modules npm cache clean npm i --progress=false
Source lives in
src/. Compiled output goes in
dist/. Configuration goes in
containers/: Stateful react components. These are usually top-level route handlers.
components/: Stateless/Dumb react components. These guys determininstically render based on props.
Configuration values are stored in the
config/ directory. You gain access to the configuration values by importing the config object from
config/index.js. The configuration values are loaded as such:
- The values in
- The values in
APP_ENVis an environment variable.
APP_ENVis not set,
config/development.jswill be loaded by default.
We use the configuration file to determine the API entry point in our actions.
- import the configuration object
- use the configuration object
- If the
APP_ENVis set to
staging, this will be the value for
Consider the following example commands:
npm run dev # runs dev server with development API APP_ENV=staging npm run dev # runs dev server with staging API APP_ENV=production npm run dev # runs dev server with production API