mirror of
https://github.com/DOI-DO/j40-cejst-2.git
synced 2025-02-23 10:04:18 -08:00
c3a68cb251
* Update code owners to include new folks and remove the departed ones * Update maintainers to reflect the current personnel * Update contributing with the latest, and make small changes to readme to make it easier to read * Update maintainers with Lucas Brown * Update installation guide to refine instructions and make them easier to follow * Try emojis to make notes stand out more * Experiment with note * Moved installation of data pipeline into a new file (contents TBD), and redid most part of the data pipeline README for clarity and readability * Add mermaid diagram * Fix table * Update readme for clarity and correctness * Update TOC * Fix comparator doc * Add section on internal score comparison * Move tox information from installation to testing * Update installation for data pipeline * Add emojis to make picking out platform-specific instructions easier * Fix Git caps * Update for readability * Add direct link to VS Code instructions * Fix broken link and improve readability * Update installation for clarity and proper case * Update python text * Clean up information about poetry and poetry lockfiles * Remove duplicate paragraph * Fix case * update date table * re-adjust table to put links at the end * Fix a few minor typos --------- Co-authored-by: Sam Powers <121890478+sampowers-usds@users.noreply.github.com>
25 lines
987 B
Markdown
25 lines
987 B
Markdown
# Local Quickstart
|
||
|
||
Install [`git`](https://git-scm.com/). See [Install Git](INSTALLATION.md#install-git).
|
||
|
||
Open a terminal, clone this repository, and change directory to the repository root:
|
||
|
||
```sh
|
||
$ git clone https://github.com/usds/justice40-tool
|
||
Cloning into 'justice40-tool'...
|
||
$ cd justice40-tool
|
||
```
|
||
|
||
Install [`docker`](https://docs.docker.com/get-docker/). See [Install Docker](INSTALLATION.md#install-docker).
|
||
|
||
> _Important_: To be able to run the entire application, you may need to increase the memory allocated for docker to at least 8096 MB. See [this post](https://stackoverflow.com/a/44533437) for more details.
|
||
|
||
Use `docker-compose` to run the application:
|
||
|
||
```sh
|
||
$ docker-compose up
|
||
```
|
||
|
||
> Note: This may take a while – possibly even an hour or two – since it has to build the containers and then download and process all the data.
|
||
|
||
After it initializes, you should be able to open the application in your browser at [http://localhost:8000](http://localhost:8000).
|