docs(readme): add setup and production deployment instructions for MVP

This commit is contained in:
Paul Huliganga 2026-03-24 18:51:59 -04:00
parent c885381d3a
commit e6d6d3f776
1 changed files with 27 additions and 12 deletions

View File

@ -61,20 +61,35 @@ npm run dev:frontend
npm test npm test
``` ```
### Production Deployment ### Production Setup & Deployment
```bash 1. **Build and start containers** (from project root):
# Build and start containers
docker-compose up -d
# View logs ```bash
docker-compose logs -f docker-compose up -d
```
# Stop 2. **Check running services:**
docker-compose down
```
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 - [Architecture Guide](ARCHITECTURE.md) — Technical decisions & patterns
- [Roadmap](ROADMAP.md) — Planned features & milestones - [Roadmap](ROADMAP.md) — Planned features & milestones
- [Agent Instructions](AGENT_INSTRUCTIONS.md) — How AI agents contribute - [Agent Instructions](AGENT_INSTRUCTIONS.md) — How AI agents contribute
- [API Docs](docs/api.md) — Endpoint reference *(coming soon)* - [API Docs](docs/api.md) — Endpoint reference
- [User Guide](docs/user-guide.md) — How to use the app *(coming soon)* - [User Guide](docs/user-guide.md) — How to use the app
--- ---