getting_started.md

Getting started

Tools

You'll need the following:

• Node.js 12

Repo

First, fork the repository so you're ready to contribute back.

1. Clone, init submodules, and add upstream

Replace yourusername below with your Github username:

git clone https://github.com/covidatlas/li.git
cd li

2. Install dependencies

npm install

If you get an error message saying you have an incompatible version of node, you may need to change versions. You can use n or nvm if you don't want to install Node.js 12.x.

Start the local dev server

Start the local dev server in one terminal:

$ npm start

The first time you run this it may take a few moments as it installs additional dependencies. At the end you'll see "Sandbox Started ... http://localhost:3333".

Crawling and sraping a source

For most folks, crawl and scrape a source in another terminal window (with the dev server still running) with the following commands

On Mac, Linux, etc:

./start --crawl <id>
./start --scrape <id>

On Windows:

node .\start --crawl <id>
node .\start --scrape <id>

Source IDs (also known as source keys) are derived from the local path of the source on the filesystem.

Sources are located in: src/shared/sources/

The path within that directory determines its key:

• us/ut/index.js is us-ut
• nyt/index.js is nyt
• us/ca/san-francisco-county is us-ca-san-francisco-county

3. Pull from upstream often

This gets you the latest sources.

git pull upstream master

Run sources

Re-generating old data

Coming soon!

Generating timeseries data

Coming soon!

Command-line options

Coming soon!

Tests

Run tests with the following:

npm run test
npm run test:unit
npm run test:integration