From 19e90214784726b2569663c437cae3254e841eb9 Mon Sep 17 00:00:00 2001 From: Claude Date: Fri, 20 Mar 2026 21:06:09 +0000 Subject: [PATCH] docs(all): Use Docker Compose as primary Quick Start, rename docker scripts Make Docker Compose the default development path in the README with a note about hot reload support. Remove the separate Local Development section. Rename docker:up to docker:db:up to clarify they only start PostgreSQL. --- AGENTS.md | 4 ++-- README.md | 10 ++++------ docs/development.md | 2 +- package.json | 4 ++-- 4 files changed, 9 insertions(+), 11 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 467b853b..fdc018db 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -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 diff --git a/README.md b/README.md index 2163f817..8689f2e7 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/development.md b/docs/development.md index 090fc9be..4d0f00b2 100644 --- a/docs/development.md +++ b/docs/development.md @@ -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 ``` diff --git a/package.json b/package.json index a95f6254..2a96aca6 100644 --- a/package.json +++ b/package.json @@ -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", + "docker:down": "docker compose down", "prepare": "husky && pnpm --filter frontend run sync", "release": "semantic-release", "version:sync": "node scripts/sync-versions.mjs",