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

Link installation again from the main README

Browse source
This commit is contained in:
Shaun Verch 2021-12-08 12:20:54 -05:00
parent e22329dc29
commit 0bb4236aa1
2 changed files with 9 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
INSTALLATION.md
View file

@ -1,14 +1,12 @@
# Installing Required Software for the Justice40 Tool
# Justice40 Tool Installation
*[¡Lea esto en español!](INSTALLATION-es.md)*
This page documents the installation steps for some of the software used to work with this project, but you may not need all of it depending on what you are trying to do.
This page documents the installation steps for some of the software needed to work with this project. After following the steps on this page, continue on to one of the following, depending on what you are trying to do:
If you want to quickly run everything locally, see [`QUICKSTART.md`](QUICKSTART.md).
If you are working with the frontend, see [`client/README.md`](client/README.md) for installation steps specific to that part of the project.
If you are working with the data pipeline, see [`data/data-pipeline/README.md`](data/data-pipeline/README.md) for installation steps specific to that part of the project.
- If you want to quickly run everything locally, see [`QUICKSTART.md`](QUICKSTART.md).
- If you are working with the frontend, see [`client/README.md`](client/README.md) for installation steps specific to that part of the project.
- If you are working with the data pipeline, see [`data/data-pipeline/README.md`](data/data-pipeline/README.md) for installation steps specific to that part of the project.
## Install Homebrew (MacOS only)
@ -23,7 +21,7 @@ Homebrew is an easy way to manage software downloads on MacOS. You don't *have*
You should regularly run `brew update` and `brew doctor` to make sure your packages are up to date and in good condition.
## IDE set up
## 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.
@ -43,7 +41,7 @@ While any IDE can be used, we're outlining how to set up VS Code
4. [Live Share Audio](https://github.com/MicrosoftDocs/live-share)
5. [Live Share Extention Pack](https://github.com/MicrosoftDocs/live-share)
### Install Git
## Install Git
#### MacOS
1. Open the terminal and type `git` and hit RETURN.

4
README.md
View file

@ -52,9 +52,9 @@ The intermediate steps of the data pipeline and the final output that is consume
If you want to run the entire application locally, see [QUICKSTART.md](QUICKSTART.md).
## Power User Guides
## Advanced Guides
If you have software experience or more specific use cases, the [project wiki](https://github.com/usds/justice40-tool/wiki) has more in depth documentation of how to work with this project.
If you have software experience or more specific use cases, the [project wiki](https://github.com/usds/justice40-tool/wiki) and [INSTALLATION.md](INSTALLATION.md) have more in depth documentation of how to work with this project.
## Glossary