Public API builder

This is a Node.js application that builds the static files that powers the COVID Tracking Project API. It is built to run on Github Actions, but can be run anywhere.

In production, it writes files to the COVID Tracking public API repository.

The design principles of this project are:

Data quality - Fail the build on any chance that data is incorrect. It is better to have stale data than wrong data.
Testability - Code should have total coverage, and data integrity should be completely testable during and after a build.
Maintainability - Opt for clear, concise patterns. Opt for code that is clearly structured over performance.
Configuration - Keep all configuration values in a central location.

Defined sources

The API currently provides the following sources:

External & Public

These are listed public endpoints:

states-info - Metadata about individual states
states - Historic and current data per state
us - Historic and current data on the country

Internal

These are public, but are intended only for use by the project website:

cdc-tests - A list of CDC public test results
press - Articles that mention or use data from the COVID Tracking Project
screnshots - Screenshot files of different state's COVID websites.
volunteers - Volunteers who opted to list themselves on the website via Slack.

OpenAPI, Swagger, and GraphQL output

The project outputs an openapi.json file and a schema.graphql file for integrating with Swagger for documentation, and building a GraphQL server.

Development

Setting up

Once you have downloaded the repository, run npm install to install dependencies.

Environment variables

COVID_API_DEBUG - Set to true to log all debug-level items to the console
GOOGLE_API_KEY - A Google API token with access to read Google spreadsheets
SLACK_TOKEN - A Slack token with access to users.profile:read and users:read scopes.
SITE_BUILD_WEBHOOK - A Netlify webhook to call if any API files changed to trigger a new site build.

Running

Just use node index.js. The following command line arguments are supported:

--source [name] - Only runs a single source name
--clean - Remove all files from the output directory

Testing

The project uses Jest and a lot of mocks for node-fetch. To run, use: npm run test

Documentation

Checkout the doc pages in /docs

Important links

Latest builds of the API
Publishing of API files
API build status also posts to #public-api-status
Website builds are posted to #website-status

COVID19Tracking / covid-public-api-build