diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index a20425df..51284a6b 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1 +1 @@ -* @switzersc-usds @nathillardusds @TomNUSDS @esfoobar-usds +* @switzersc-usds @nathillardusds @TomNUSDS @esfoobar-usds @ginabeena diff --git a/MAINTAINERS.md b/MAINTAINERS.md index b6f23a47..b6ade5b4 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -8,6 +8,7 @@ - Nat Hillard - NatHillardUSDS - Jorge Escobar - esfoobar-usds - Tom Nielsen - TomNUSDS +- Gina Maini - ginabeena ## Product - Katherine Mlika - katherinedm-usds diff --git a/docs/README.md b/docs/README.md index ffe8a5ea..fe8982fe 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,37 @@ +# Installation Prerequisites + +1. [Install the latest docker](https://docs.docker.com/get-docker/) and you may want to install [docker desktop - latest](https://docs.docker.com/desktop/) +2. [Install python 3.9.5 (latest) and](https://www.python.org/downloads/) [configure your environment](https://docs.python.org/3/tutorial/venv.html) to get data-platform source environment ready. +3. Install Visual Studio Code (python packages & typescript) +4. [Installing nvm](https://github.com/nvm-sh/nvm#installing-and-updating) and then do: +```sh +nvm install 14.17.0 + +nvm use 14.17.0 +``` +and now when you do: +```sh +node -v +``` +you should see: +```sh +v14.17.0 +``` +6. Install [node.js](https://nodejs.org/en/download/) and install all dependencies by `cd`ing into the `/client` directory and running: + +```sh +npm install +``` +* Note: `npm install` will check the `package-lock.json` fill and restore all transitive dependencies that are in the lock. + +# Build + + + +# PR Process & Git Flow + +[See Contributing.md](../CONTRIBUTING.md) + # Documentation Here you'll find all Justice40 project documentation.