docs: update README with current progress and quick start
Some checks failed
Deploy to Coolify / Code Quality (push) Has been cancelled
Deploy to Coolify / Run Tests (push) Has been cancelled
Deploy to Coolify / Deploy to Development (push) Has been cancelled
Deploy to Coolify / Deploy to Production (push) Has been cancelled
Deploy to Coolify / Deploy to Test (push) Has been cancelled
Some checks failed
Deploy to Coolify / Code Quality (push) Has been cancelled
Deploy to Coolify / Run Tests (push) Has been cancelled
Deploy to Coolify / Deploy to Development (push) Has been cancelled
Deploy to Coolify / Deploy to Production (push) Has been cancelled
Deploy to Coolify / Deploy to Test (push) Has been cancelled
- Add ./dev.sh one-command startup - Update MVP status: 14/34 complete (41.2%) - Link to DEV_SETUP.md for detailed guide - Show Week 1-2 complete, Week 3 in progress
This commit is contained in:
52
README.md
52
README.md
@@ -22,18 +22,28 @@ A simple, modern kitchen inventory app that the whole family can actually use. B
|
||||
- 🔒 **Self-hosted** — Your data stays yours
|
||||
- 🌐 **Open Food Facts** — Auto-fill product data from barcodes
|
||||
|
||||
## 🚀 Quick Start
|
||||
## 🚀 Quick Start (Local Development)
|
||||
|
||||
```bash
|
||||
# Clone
|
||||
# Clone repository
|
||||
git clone https://gitea.jeanlucmakiola.de/pantry-app/pantry.git
|
||||
cd pantry
|
||||
|
||||
# Start services (Docker Compose)
|
||||
docker-compose up -d
|
||||
|
||||
# Access at http://localhost:3000
|
||||
# One-command startup
|
||||
./dev.sh
|
||||
```
|
||||
|
||||
**What this does:**
|
||||
1. Starts Supabase (PostgreSQL + API + Auth + Studio)
|
||||
2. Installs frontend dependencies
|
||||
3. Launches Nuxt dev server
|
||||
|
||||
**Access:**
|
||||
- App: `http://localhost:3000`
|
||||
- Supabase Studio: `http://localhost:54323`
|
||||
|
||||
**See [DEV_SETUP.md](DEV_SETUP.md) for detailed setup guide.**
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
- [**Project Plan**](docs/PROJECT_PLAN.md) — Vision, roadmap, phases
|
||||
@@ -73,18 +83,32 @@ pantry/
|
||||
3. **Extendable** — Clean architecture for future features
|
||||
4. **Self-hosted first** — No SaaS plans, no lock-in
|
||||
|
||||
## 📋 MVP Status
|
||||
## 📋 MVP Status (14/34 Complete - 41.2%)
|
||||
|
||||
**Target:** v0.1 (6-week sprint)
|
||||
**Current Phase:** Week 2 ✅ Complete, Week 3 🔄 In Progress
|
||||
|
||||
✅ **Week 1 - Foundation (6/6)**
|
||||
- Database schema + RLS policies
|
||||
- Nuxt 4 app scaffold
|
||||
- Supabase integration
|
||||
- App layout
|
||||
|
||||
✅ **Week 2 - Core Inventory (8/8)**
|
||||
- SQL helper functions
|
||||
- Seed data (units + tags)
|
||||
- Inventory CRUD UI
|
||||
- Add/Edit/Delete components
|
||||
|
||||
🔄 **Week 3 - Barcode Scanning (1/5)**
|
||||
- BarcodeScanner component
|
||||
- html5-qrcode integration
|
||||
- Product lookup (pending)
|
||||
- Scan-to-add flow (pending)
|
||||
|
||||
⏸️ **Week 4-6** - Tag UI, PWA, Deployment (20 issues)
|
||||
|
||||
See [PROJECT_PLAN.md](docs/PROJECT_PLAN.md) for detailed roadmap.
|
||||
|
||||
- [ ] Foundation (Nuxt + Supabase + Auth)
|
||||
- [ ] Core inventory (CRUD, tags, units)
|
||||
- [ ] Barcode scanning (PWA camera + Open Food Facts)
|
||||
- [ ] Mobile polish (PWA, offline)
|
||||
- [ ] Docker deployment
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
This is an early-stage project. Contributions welcome once v0.1 ships.
|
||||
|
||||
Reference in New Issue
Block a user