publicdata/j40-cejst-2
1
0
Fork 0
mirror of https://github.com/DOI-DO/j40-cejst-2.git synced 2025-02-22 17:44:20 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions
j40-cejst-2/docs
History
Jorge Escobar c8a7f81f7c
habemus score! 🎉 (#185) 
* habemus score!

* etl process for score

* small typo

* adding in score percentiles

Co-authored-by: lucasmbrown-usds <lucas.m.brown@omb.eop.gov>
2021-06-18 10:16:19 -04:00
..
architecture Fixes #18 - Addresses potential architecture on geoplatform.gov (#45) 2021-05-19 08:40:05 -04:00
decisions habemus score! 🎉 (#185) 2021-06-18 10:16:19 -04:00
glossary.md As an open source community member, I want to know what Justice40-specific terms and acronyms mean. (#75) 2021-05-24 10:14:39 -04:00
README.md Added readme information under /docs about building and prerequisites (#126) 2021-06-17 15:44:41 -04:00

README.md

Installation Prerequisites

  1. Install the latest docker and you may want to install docker desktop - latest
  2. Install python 3.9.5 (latest) and configure your environment to get data-platform source environment ready.
  3. Install Visual Studio Code (python packages & typescript) <TODO: add .vscode>
  4. Installing nvm and then do:
nvm install 14.17.0

nvm use 14.17.0

and now when you do:

node -v

you should see:

v14.17.0
  1. Install node.js and install all dependencies by cding into the /client directory and running:
npm install
  • Note: npm install will check the package-lock.json fill and restore all transitive dependencies that are in the lock.

Build

<TODO: .vscode/task.json file with build commands for each backend>

PR Process & Git Flow

See Contributing.md

Documentation

Here you'll find all Justice40 project documentation.

In particular:

  • Decisions - Documentation of significant project decisions
  • Data Roadmap - a description of our process for adding new datasets to our backlog