Skip to content

Commit c5224f0

Browse files
committed
docs: use Docker Compose as primary Quick Start, rename docker scripts
Make Docker Compose the default development path in the README, with a separate Local Development section for faster Node.js iteration. Add seed script to both paths. Rename docker:up/docker:down to docker:db:up/docker:db:down to clarify they only start PostgreSQL for local development. https://claude.ai/code/session_01JTbjLrkLpw9qMsaLup2Kqa
1 parent 1442fd8 commit c5224f0

File tree

4 files changed

+21
-8
lines changed

4 files changed

+21
-8
lines changed

AGENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ pnpm check # Lint + format
5353
pnpm test # Run all tests
5454

5555
# Docker
56-
pnpm docker:up # Start database
57-
pnpm docker:down # Stop database
56+
pnpm docker:db:up # Start PostgreSQL + PostGIS
57+
pnpm docker:db:down # Stop database
5858
```
5959

6060
## Quick Reference

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,23 @@ A self-hostable web application for relationship management. Think of it as your
1313
## Quick Start
1414

1515
```bash
16-
# Prerequisites: Node.js 24+, pnpm 8+, PostgreSQL 18+ (or Docker)
16+
docker compose up -d
17+
docker compose exec backend pnpm migrate
18+
docker compose exec backend pnpm seed # Optional: populate with sample data
19+
```
20+
21+
The app is available at `http://localhost:8080` (nginx reverse proxy).
22+
23+
## Local Development
24+
25+
For faster iteration on the Node.js apps (hot reload without container overhead):
26+
27+
```bash
28+
# Prerequisites: Node.js 24+, pnpm 8+
29+
docker compose up -d
1730
pnpm install
18-
pnpm docker:up
1931
pnpm migrate
32+
pnpm seed # Optional: populate with sample data
2033
pnpm dev
2134
```
2235

docs/development.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ pnpm pgtyped:watch # Watch and regenerate types
3737
pnpm seed # Seed database with test data
3838

3939
# Docker
40-
pnpm docker:up # Start Docker services
41-
pnpm docker:down # Stop Docker services
40+
pnpm docker:db:up # Start PostgreSQL + PostGIS
41+
pnpm docker:db:down # Stop Docker services
4242
```
4343

4444
## Git Conventions

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@
2525
"pgtyped": "pnpm --filter backend run pgtyped",
2626
"pgtyped:watch": "pnpm --filter backend run pgtyped:watch",
2727
"seed": "pnpm --filter backend run seed",
28-
"docker:up": "docker-compose up -d",
29-
"docker:down": "docker-compose down",
28+
"docker:db:up": "docker compose up postgres -d",
29+
"docker:db:down": "docker compose down",
3030
"prepare": "husky && pnpm --filter frontend run sync",
3131
"release": "semantic-release",
3232
"version:sync": "node scripts/sync-versions.mjs",

0 commit comments

Comments
 (0)