publicdata/j40-cejst-2
1
0
Fork 0
mirror of https://github.com/DOI-DO/j40-cejst-2.git synced 2025-02-22 01:31:25 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions
j40-cejst-2/QUICKSTART.md
Travis Newby c3a68cb251
[SPIKE] Improve backend documentation (#2177) 
* 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>
2023-02-28 15:11:57 -06:00

987 B
Raw Permalink Blame History

Local Quickstart

Install git. See Install Git.

Open a terminal, clone this repository, and change directory to the repository root:

$ git clone https://github.com/usds/justice40-tool
Cloning into 'justice40-tool'...
$ cd justice40-tool

Install docker. See 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 for more details.

Use docker-compose to run the application:

$ 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.