Skip to content

Commit

Permalink
add docs on exposed ports for local developement
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
dpgraham4401 committed Nov 9, 2023
1 parent 3ef6bcb commit beabc15
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions docs/guide/src/development/local-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit beabc15

Please sign in to comment.