An application for modeling the impact of COVID-19 in jails and prisons.
As of February 1, 2022, this application has officially been turned down.
No further updates are planned in this application, including security patches.
If you need additional support modeling COVID-19 outbreaks, or monitoring release cohort outcomes, please contact our team.
If you are hoping to run this application yourself (and we really hope there is
no cause to do so!), read on below for instructions on working with the frontend.
Make sure to check out the backend/README for instructions on working with the
backend.
npm install -g yarn
yarn installyarn devServes from http://localhost:8000/.
If you want to a specific port, like 1234, just add --port 1234.
Default environment variables (for feature flags, etc) for local development can be found
in .env-example. You should copy them to .env.development (untracked) to properly configure
your development environment; this file will be consumed by Gatsby dev builds. Edit your local
.env.development as needed and commit new env vars to the example file when appropriate.
Environment variables for deployments are configured by Now. Let admins know when there are
new env vars that need to be set for Preview or Production deployments. (You can test them in
production builds locally with a .env.production file, also untracked.)
yarn buildBuilt files can be found in public/.
An easy way to test out the built files:
yarn serveIf you want to a specific port, like 1234, just add --port 1234.
Authentication and authorization are provided by Auth0.
The Auth0 tenant for the production, hosted instance of this app is controlled by Recidiviz. If you are working with Recidiviz on the production instance, reach out to covid@recidiviz.org about receiving your log in credentials.
Automated tests can be run with Jest and
React Testing Library.
Should you need to inspect the Jest configuration, you will find it
in /package.json and /setupTests.tsx.
yarn test # run the entire test suite
yarn test --watch # re-run tests as you make changes. Pass any Jest options you like- You'll want to install the React Dev Tools in the browser
- If you're using VSCode, you may find these extensions helpful:
- https://marketplace.visualstudio.com/items?itemName=mgmcdermott.vscode-language-babel
- https://marketplace.visualstudio.com/items?itemName=jpoissonnier.vscode-styled-components
- https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint
- https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode