Skip to content

Simplify Docker setup and improve local development workflow #140

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

Open
enko wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −11
Open

Simplify Docker setup and improve local development workflow #140

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ pnpm check # Lint + format
pnpm test # Run all tests

# Docker
pnpm docker:up # Start database
pnpm docker:down # Stop database
pnpm docker:db:up # Start PostgreSQL + PostGIS
pnpm docker:down # Stop docker stack
```

## Quick Reference
Expand Down
10 changes: 4 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,12 @@ A self-hostable web application for relationship management. Think of it as your
## Quick Start

```bash
# Prerequisites: Node.js 24+, pnpm 8+, PostgreSQL 18+ (or Docker)
pnpm install
pnpm docker:up
pnpm migrate
pnpm dev
docker compose up -d
docker compose exec backend pnpm migrate
docker compose exec backend pnpm seed # Optional: populate with sample data
```

Frontend runs at `http://localhost:5173`, backend at `http://localhost:3000`.
The app is available at `http://localhost:8080` (nginx reverse proxy). This setup also works well for development — source code is mounted into the containers with hot reload enabled.

## Documentation

Expand Down
2 changes: 1 addition & 1 deletion docs/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ pnpm pgtyped:watch # Watch and regenerate types
pnpm seed # Seed database with test data

# Docker
pnpm docker:up # Start Docker services
pnpm docker:db:up # Start PostgreSQL + PostGIS
pnpm docker:down # Stop Docker services
```

Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@
"pgtyped": "pnpm --filter backend run pgtyped",
"pgtyped:watch": "pnpm --filter backend run pgtyped:watch",
"seed": "pnpm --filter backend run seed",
"docker:up": "docker-compose up -d",
"docker:down": "docker-compose down",
"docker:db:up": "docker compose up postgres -d",
Copy link

Copilot AI Mar 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docker:db:up uses docker compose up postgres -d. Elsewhere in the repo the documented pattern is docker compose up -d postgres (e.g. docs/postgis-address-autocomplete.md), which also matches the canonical CLI syntax. Reordering the args will keep docs consistent and avoid edge-case parsing differences across Docker/Compose versions.

Suggested change
"docker:db:up": "docker compose up postgres -d",
"docker:db:up": "docker compose up -d postgres",

Copilot uses AI. Check for mistakes.
"docker:down": "docker compose down",
Comment on lines +28 to +29
Copy link

Copilot AI Mar 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR description says docker:down was renamed to docker:db:down (and docker:db is mentioned as the “db only” script), but package.json still defines docker:down and introduces docker:db:up. Either update the scripts to match the documented naming, or adjust the PR description/docs to reflect the actual script names to avoid confusion for contributors.

Copilot uses AI. Check for mistakes.
"prepare": "husky && pnpm --filter frontend run sync",
"release": "semantic-release",
"version:sync": "node scripts/sync-versions.mjs",
Expand Down
Loading