publicdata/j40-cejst-2
1
0
Fork 0
mirror of https://github.com/DOI-DO/j40-cejst-2.git synced 2025-02-22 09:41:26 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions
j40-cejst-2/docs
History
Nat Hillard 4443f60b44
Adding ADR for using maplibre to repo (see issue #299) (#325) 
* Adding ADR for using maplibre to repo (see issue #299)
2021-07-12 18:11:56 -04:00
..
architecture Update README.md (#222) 2021-06-30 07:15:35 -07:00
decisions Adding ADR for using maplibre to repo (see issue #299) (#325) 2021-07-12 18:11:56 -04:00
glossary.md Update glossary.md (#224) 2021-06-30 07:13:59 -07: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