j40-cejst-2/QUICKSTART.md

# 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).
Update documentation to make it easier for users to find the right content for them (#1016) * First pass of updating documentation for new users Trying to look at this from the perspective of someone new to the project, and create some pathways to make it easier for people to get to the content they are looking for. * Make it clear that docker is doing the setup * Link installation again from the main README * Add some docs about the github actions * Add markdown link check * Move git installation first * Add config for markdown link checker * Fix some links * Correct handling of repo root relative links * Fix broken links in data roadmap * Fix more broken links * Fix more links * Ignore link that's returning a 403 to the checker It actually works if you go in a browser. * Fix another broken link * Ignore more urls that don't work * Update the readme under docs * Add some more dataset links * More strongly call out the quickstart * Try to call out even more the quickstart link * Fix dead links * Add note about initialization time * Remove broken link from spanish install guide These will be updated later with a full translation 2021-12-16 10:16:28 -05:00			`# 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`
			```

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			`> 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).`