From e6d6d3f776b251bf399428c69e16e445244b50f0 Mon Sep 17 00:00:00 2001 From: Paul Huliganga Date: Tue, 24 Mar 2026 18:51:59 -0400 Subject: [PATCH] docs(readme): add setup and production deployment instructions for MVP --- README.md | 39 +++++++++++++++++++++++++++------------ 1 file changed, 27 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index f705913..94e3cf8 100644 --- a/README.md +++ b/README.md @@ -61,20 +61,35 @@ npm run dev:frontend npm test ``` -### Production Deployment +### Production Setup & Deployment -```bash -# Build and start containers -docker-compose up -d +1. **Build and start containers** (from project root): -# View logs -docker-compose logs -f + ```bash + docker-compose up -d + ``` -# Stop -docker-compose down -``` +2. **Check running services:** -Access at `http://localhost:3000` (or `https://recipes.paje.ca` in production). + ```bash + docker-compose ps + ``` + +3. **View container logs:** + + ```bash + docker-compose logs -f + ``` + +4. **Access the app:** + - Frontend: http://localhost:8080 (default) + - Backend API: http://localhost:3000 + +5. **Stop services:** + + ```bash + docker-compose down + ``` --- @@ -139,8 +154,8 @@ recipe-manager/ - [Architecture Guide](ARCHITECTURE.md) — Technical decisions & patterns - [Roadmap](ROADMAP.md) — Planned features & milestones - [Agent Instructions](AGENT_INSTRUCTIONS.md) — How AI agents contribute -- [API Docs](docs/api.md) — Endpoint reference *(coming soon)* -- [User Guide](docs/user-guide.md) — How to use the app *(coming soon)* +- [API Docs](docs/api.md) — Endpoint reference +- [User Guide](docs/user-guide.md) — How to use the app ---