publicdata/j40-cejst-2
1
0
Fork 0
mirror of https://github.com/DOI-DO/j40-cejst-2.git synced 2025-02-23 10:04:18 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions
j40-cejst-2/docs
History
Shaun Verch 7f3ee6cff4 Fix more broken links
2021-12-15 12:17:47 -05:00
..
architecture Update diagrams in architecture docs (#790) 2021-10-08 13:12:03 -04:00
decisions Adding ADR PR for associated ADR issue #402 (#437) 2021-08-02 10:17:44 -04:00
glossary.md Update glossary.md (#224) 2021-06-30 07:13:59 -07:00
Justice40_Open_Source_Community_Orientation.pptx Add orientation deck to docs (#863) 2021-11-05 13:21:26 -04:00
README.md Fix more broken links 2021-12-15 12:17:47 -05: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