COVID Tracking Project

The COVID Tracking Project collects information from 50 U.S. states, the District of Columbia, and 5 other U.S. territories to provide the most comprehensive testing data we can collect for the novel coronavirus, SARS-CoV-2.

This repository is for the project's website: https://covidtracking.com/.

Development

The website is built on GatsbyJS. If you are not familiar with Gatsby, we suggest checking out their excellent documentation.

Environment Variables

Our content is managed in Contentful. All required environment variables are listed (with dummy values) in .env.example and you can easily duplicate this file with cp .env.example .env, then replace each value with the values you'll find in our storybook documentation.

Install

First, you'll need the Gatsby command line interface installed globally:

npm install -g gatsby-cli

Then, install all dependencies by running:

npm install

After, you will need to pull the most recent data files to your machine.

npm run setup

To run the website locally, use:

gatsby develop

The site is now running at http://localhost:8000. Any changes you make to code is live-updated. There is a GraphQL preview tool available at http://localhost:8000/___graphql to see what data is exposed to the website.

Note that any changes you make while running Gatsby will automatically checked with ESLint, so check your console as you save files.

Storybook

All common components throughout the site are documented in Storybook. You can find all our component stories in /src/stories.

To preview the storybook locally, just run:

npm run storybook

The storybook is now available at http://localhost:6006.

How to contribute

No matter how you choose to help, we would love to have you as part of the project. Check our Contributing Guide for information on how to file issues and make pull requests.

ymkjp / website