b1ef7e43be
Some checks failed
Deploy to Coolify / Code Quality (pull_request) Has been cancelled
Deploy to Coolify / Run Tests (pull_request) Has been cancelled
Deploy to Coolify / Deploy to Development (pull_request) Has been cancelled
Deploy to Coolify / Deploy to Production (pull_request) Has been cancelled
Deploy to Coolify / Deploy to Test (pull_request) Has been cancelled
Pull Request Checks / Validate PR (pull_request) Has been cancelled
Organized docs into logical subdirectories:
**New Structure:**
- docs/
- README.md (index with quick links)
- PROJECT_PLAN.md (root level - main roadmap)
- development/
- getting-started.md (5-min quickstart)
- local-setup.md (detailed Docker Compose guide)
- workflow.md (daily development)
- git-workflow.md (branching strategy)
- architecture/
- overview.md (tech stack, design)
- database.md (schema, RLS, migrations)
- api.md (endpoints, functions)
- deployment/
- production.md (Docker, Coolify)
- ci-cd.md (automated pipelines)
**Cleaned Up:**
- Moved DEV_SETUP.md → docs/development/local-setup.md
- Removed outdated SETUP.md (referenced old Coolify setup)
- Replaced with getting-started.md (current Docker Compose flow)
- Updated README.md links to new structure
All paths tested, no broken links.
85 lines
2.7 KiB
Markdown
85 lines
2.7 KiB
Markdown
# Pantry Documentation
|
|
|
|
Complete documentation for the Pantry household inventory management system.
|
|
|
|
## 📚 Documentation Structure
|
|
|
|
### 🚀 Getting Started
|
|
|
|
- **[Project Overview](PROJECT_PLAN.md)** - Vision, roadmap, and MVP phases
|
|
- **[Local Setup Guide](development/local-setup.md)** - Docker Compose development environment
|
|
- **[Getting Started](development/getting-started.md)** - Quick start for new developers
|
|
|
|
### 🏗️ Architecture
|
|
|
|
- **[Architecture Overview](architecture/overview.md)** - Tech stack, design decisions, data flow
|
|
- **[Database Schema](architecture/database.md)** - Tables, relationships, RLS policies, migrations
|
|
- **[API Reference](architecture/api.md)** - Supabase endpoints, Edge Functions, helpers
|
|
|
|
### 💻 Development
|
|
|
|
- **[Development Workflow](development/workflow.md)** - Daily workflow, conventions, best practices
|
|
- **[Git Workflow](development/git-workflow.md)** - Branching strategy, PR process, reviews
|
|
|
|
### 🚢 Deployment
|
|
|
|
- **[Production Deployment](deployment/production.md)** - Docker, Coolify, environment setup
|
|
- **[CI/CD Pipeline](deployment/ci-cd.md)** - Automated testing, builds, deployments
|
|
|
|
---
|
|
|
|
## 🎯 Quick Links by Role
|
|
|
|
### New Developer
|
|
1. [Local Setup Guide](development/local-setup.md) - Get running in 5 minutes
|
|
2. [Architecture Overview](architecture/overview.md) - Understand the stack
|
|
3. [Development Workflow](development/workflow.md) - Daily development process
|
|
|
|
### Feature Implementation
|
|
1. [Database Schema](architecture/database.md) - Table structure and queries
|
|
2. [API Reference](architecture/api.md) - Available endpoints
|
|
3. [Git Workflow](development/git-workflow.md) - Branch naming, PR checklist
|
|
|
|
### Deployment & Operations
|
|
1. [Production Deployment](deployment/production.md) - Deploy to production
|
|
2. [CI/CD Pipeline](deployment/ci-cd.md) - Automated workflows
|
|
|
|
---
|
|
|
|
## 📊 Current Status
|
|
|
|
**MVP Progress:** 14/34 issues complete (41.2%)
|
|
|
|
- ✅ Week 1: Database + Frontend Foundation (6/6)
|
|
- ✅ Week 2: Core Inventory Management (8/8)
|
|
- 🔄 Week 3: Barcode Scanning (1/5)
|
|
- ⏸️ Week 4-6: Tag UI, PWA, Deployment (20 remaining)
|
|
|
|
See [PROJECT_PLAN.md](PROJECT_PLAN.md) for detailed roadmap.
|
|
|
|
---
|
|
|
|
## 🤝 Contributing
|
|
|
|
For contribution guidelines, see [Development Workflow](development/workflow.md).
|
|
|
|
Key points:
|
|
- Feature branches off `develop`
|
|
- PRs require review before merge
|
|
- Follow conventional commits
|
|
- Write tests for new features
|
|
|
|
---
|
|
|
|
## 🔗 External Resources
|
|
|
|
- **Repository:** https://gitea.jeanlucmakiola.de/pantry-app/pantry
|
|
- **Supabase Docs:** https://supabase.com/docs
|
|
- **Nuxt 4 Docs:** https://nuxt.com
|
|
- **Open Food Facts API:** https://wiki.openfoodfacts.org/API
|
|
|
|
---
|
|
|
|
**Last Updated:** 2026-02-09
|
|
**Version:** 0.1.0-alpha (MVP in progress)
|