From beabc15c188cbcff726511270a5d4c5ed87f4c66 Mon Sep 17 00:00:00 2001 From: David Paul Graham <43794491+dpgraham4401@users.noreply.github.com> Date: Mon, 30 Oct 2023 15:43:48 -0400 Subject: [PATCH] add docs on exposed ports for local developement Adds a short blurb for newcomers to get up and running on their local machine about how the app is exposed on their local machine. --- docs/guide/src/development/local-development.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/guide/src/development/local-development.md b/docs/guide/src/development/local-development.md index 7082fc647..18218761f 100644 --- a/docs/guide/src/development/local-development.md +++ b/docs/guide/src/development/local-development.md @@ -34,10 +34,17 @@ cp ./configs/.env.dev .env docker compose up --build ``` -Don't forget the `--build` flag, or you'll be running the last built image instead of the Dockerfile's build target -that we've specified in the [docker-compose.yaml](https://github.com/USEPA/haztrak/blob/main/docker-compose.yaml) file. +*You may find that after some changes (e.g., to the database) you need to rebuild the containers instead of restarting them. +In that case, use the `--build` flag, or you'll be running the last built image instead of the Dockerfile's build target +that we've specified in the [docker-compose.yaml](https://github.com/USEPA/haztrak/blob/main/docker-compose.yaml) file.* -## Fixtures +After all containers are successfully running (you can inspect with `docker ps`), visit one of the following + +- [localhost:3000](http://localhost:3000) to visit the browser client (React.js application) +- [localhost:8000/admin](http://localhost:8000/admin) to login to the admin interface +- The database will be exposed on port `5432` and Redis will be exposed on port `6379` of your local machine. + +## Fixtures (logging in) - On start, fixtures will be loaded to the database, including 2 users to aid local development.