j40-cejst-2/INSTALLATION.md

85 lines
4.1 KiB
Markdown
Raw Normal View History

# Justice40 Tool Installation
_[¡Lea esto en español!](INSTALLATION-es.md)_
This page documents the installation steps for some of the software needed to work with this project.
> **NOTE: If all you want to do is quickly run everything locally to try out the application, go straight to [`QUICKSTART.md`](QUICKSTART.md).**
After the generic installation steps on this page, continue to one of the following, depending on what you are trying to do:
- If you are working with the frontend, see [`client/README.md`](client/README.md).
- If you are working with the data pipeline, see [`data/data-pipeline/README.md`](data/data-pipeline/README.md).
- If you want to understand the current deployment process, see [`.github/workflows/README.md`](.github/workflows/README.md).
## Install Git
### MacOS
1. Open the terminal and type `git` and hit RETURN.
2. If dev tools are not installed a window will prompt you to install dev tools.
3. Open the terminal and type `git --version` and hit RETURN.
4. Validate that a version number is returned. If so, git is properly installed.
### Win10
Download from [website](https://git-scm.com/download/win)
## Install Homebrew (MacOS only)
Homebrew is an easy way to manage software downloads on MacOS. You don't _have_ to use it, but we recommend it.
1. First, open your terminal and run `brew -v` to determine whether you have Homebrew installed. If you get a response that looks something like `Homebrew 3.1.9`, you've already got it! If you get nothing back, or an error, continue.
2. Open the terminal and copy/paste this command and hit RETURN. Go through the prompts (you will need to grant `sudo` access).
`/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"`
2. Validate installation by typing `brew -v` in the terminal and ensure a version number is shown.
You should regularly run `brew update` and `brew doctor` to make sure your packages are up to date and in good condition.
### Install Node using NVM
This will work for both MacOS and Win10. Follow instructions on this [link](https://medium.com/@nodesource/installing-node-js-tutorial-using-nvm-5c6ff5925dd8). Be sure to read through the whole doc to find the sections within each step relevant to you (e.g. if you're using Homebrew, when you get to Step 2 look for the section, "Install NVM with Homebrew").
If you install NVM using Homebrew, make sure to read the output in terminal after you run `brew install nvm`. You will need to add a few lines to your ~/.bash_profile and perhaps complete a couple other tasks.
Once you install NVM, don't forget to install Node! This is included in the linked tutorial above.
After you've downloaded the nvm and the latest node (using the above steps) also install node version 14 by:
`brew install node@14`
You should then be able to switch to that version of node by:
`nvm use 14`
To validate you are using node 14, type:
`node -v`
This should return *Now using node 14.x.x (npm v6.x.x)*
## IDE set up (Optional)
While any IDE can be used, we're outlining how to set up VS Code
1. Open the terminal and type `brew install --cask visual-studio-code` and hit RETURN.
1. If this doesn't work or for Win10, you can download VS Code from the [website](https://code.visualstudio.com/).
2. After [forking this repo](https://github.com/usds/justice40-tool/blob/main/CONTRIBUTING.md#code-contributions), you can clone your forked repo into VS Code
3. VS Code with prompt you to "clone a repo"
4. Open the terminal and navigate to `client` directory
5. Type `npm install` to load dependencies
6. Type `gatsby develop` to spin up the app
7. Navigate to `localhost:8000` to view the app
### Recommended VS Code Extensions
1. [Browser Preview](https://github.com/auchenberg/vscode-browser-preview)
2. [Live Server](https://github.com/ritwickdey/vscode-live-server)
3. [Live Share](https://github.com/MicrosoftDocs/live-share)
4. [Live Share Audio](https://github.com/MicrosoftDocs/live-share)
5. [Live Share Extention Pack](https://github.com/MicrosoftDocs/live-share)
## Install Docker
Follow the [Docker installation
instructions](https://docs.docker.com/get-docker/) for your platform.