Skip to content

BDMS-463: Docker Compose Update #384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jirhiker merged 2 commits into from
Jan 15, 2026
Merged

BDMS-463: Docker Compose Update #384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1844fae
fix: update app.environment postgres_port for app to db network consi…
chasetmartin Jan 15, 2026
3c55b75
feat: update readme to better reflect docker-compose workflow
chasetmartin Jan 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 16 additions & 43 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,69 +97,42 @@ Notes:
- You can find the exact location from `psql` with: `SHOW config_file;`
- After changing the port, restart PostgreSQL so the new port takes effect.

In development set `MODE=development` to allow lexicon enums to be populated.
In development set `MODE=development` to allow lexicon enums to be populated. When `MODE=development`, the app attempts to seed the database with 10 example records via `transfers/seed.py`; if a `contact` record already exists, the seed step is skipped.

#### 5. Database and server

Choose one of the following:

<table>
<tr>
<td>
PostgreSQL + PostGIS installed locally
</td>
<td>
Docker
</td>
</tr>
<tr>
<td>
**Option A: Local PostgreSQL + PostGIS**

```bash
#run database migrations
# run database migrations
alembic upgrade head

# start development server
uvicorn app.main:app --reload
```

</td>
<td>

Notes:
* Requires PostgreSQL with PostGIS installed locally.
* Use the `POSTGRES_*` settings in `.env` for your local instance.

**Option B: Docker Compose (dev)**

```bash
# include -d flag for silent/detached build
docker compose up --build
```

</td>
</tr>
<tr>
<td>
Requires PostgreSQL and PostGIS extensions to be installed locally
</td>
<td>
Requires Docker Desktop to be installed locally
</td>
</tr>
<tr>
<td>
</td>
<td>
Run <code>docker exec -it nmsamplelocations-app-1 bash</code> to open a shell inside the running app container.
</td>
</tr>
<tr>
<td>
</td>
<td>
After the database container is running, you can run tests with Pytest from your local command line (not necessarily inside the app container).
</td>
</tr>
</table>

Notes:
* Requires Docker Desktop.
* Spins up two containers: `db` (PostGIS/PostgreSQL) and `app` (FastAPI API service).
* `alembic upgrade head` runs on app startup after `docker compose up`.
* The database listens on `5432` in the container and is published to your host as `54321`. Ensure `POSTGRES_PORT=54321` in your `.env` to run local commands against the Docker DB (e.g., `uv run pytest`, `uv run python -m transfers.transfer`).

#### Staging Data

To get staging data into the database run `python -m transfers.transfer` from the root directory of the project.
To get staging data into the database: `python -m transfers.transfer` from the root directory of the project.

### 🧭 Project Structure
```text
Expand Down
1 change: 1 addition & 0 deletions docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ services:
- POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
- POSTGRES_DB=${POSTGRES_DB}
- POSTGRES_HOST=db
- POSTGRES_PORT=5432
- MODE=${MODE}
- AUTHENTIK_DISABLE_AUTHENTICATION=${AUTHENTIK_DISABLE_AUTHENTICATION}
ports:
Expand Down
Loading