j40-cejst-2/QUICKSTART.md
Shaun Verch f90ec76295
More obviously call out deploy time in quickstart (#1113)
Just to set expectation that this will take a while, so new users don't
think they did something wrong.
2022-01-10 16:34:43 -05:00

25 lines
969 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://www.docker.com/). 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).