cmu-delphi / delphi-epidata

An open API for epidemiological data.
https://cmu-delphi.github.io/delphi-epidata/
MIT License
100 stars 62 forks source link

docs: simplify outdated dev instructions #1466

Closed dshemetov closed 1 week ago

dshemetov commented 1 month ago

Summary:

Our dev instructions here are quite old and contain either out of date or duplicate information that is already in dev scripts. So here I removed some unnecessary and out of date details and pointed to the dev scripts instead. This way we don't have to keep updating this instructions along with those files. I did my best to keep the useful examples in the "Manual Tests" section around, such as loading test data into the database and querying the local API directly from the command line (though the diffs make it look like I deleted all that, it's actually kept around unaltered below).

Prerequisites:

sonarcloud[bot] commented 1 week ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud