Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

FitBox Documentation

Welcome to the FitBox meal delivery platform documentation. This directory contains all technical and business documentation organized for easy navigation and maintenance.

📁 Documentation Structure

docs/
├── README.md                          # This file
├── development/                       # Developer guides and standards
│   ├── README.md                     # Main development guide
│   └── testing-guide.md              # Comprehensive testing documentation
├── design/                           # Design system and UI specifications
│   ├── design-system.md              # Design system overview
│   ├── requirements.md               # MVP UI/UX requirements
│   ├── component-research.md         # Component selection research
│   ├── usage-guide.md                # Implementation patterns
│   ├── components/                   # Component specifications
│   └── tokens/                       # Design tokens and variables
├── specifications/                   # Technical and business specifications
│   ├── README.md                     # Specifications overview
│   ├── business-requirements.md      # Feature specifications
│   ├── bundle-selection-spec.md      # Revenue optimization strategy
│   ├── technical-architecture.md     # System design
│   ├── database-design.md            # Data models and relationships
│   ├── tasks.md                      # Implementation roadmap (39 MVP tasks)
│   ├── quickstart.md                 # User journey validation
│   ├── research.md                   # Technology decisions
│   ├── api-endpoints.md              # Complete REST API reference
│   └── contracts/                    # OpenAPI specification and testing
└── guides/                          # User guides and troubleshooting
    ├── documentation-standards.md    # Documentation organization rules
    ├── troubleshooting.md            # Common issues and solutions
    └── contributing.md               # Contribution guidelines

🚀 Quick Navigation

For New Developers

  1. Main README - Project overview and quick start
  2. Development Guide - Coding standards and setup
  3. Current Tasks - What to work on next
  4. Testing Guide - Testing methodology

For Designers

  1. Design System - Component library and tokens
  2. MVP Requirements - UI/UX specifications
  3. Usage Guide - Implementation patterns

For Product/Business

  1. Business Requirements - Feature specifications
  2. Bundle Strategy - Revenue model
  3. User Journeys - Validation scenarios

For DevOps/Infrastructure

  1. Technical Architecture - System design
  2. Database Design - Data models
  3. API Endpoints - Complete API reference
  4. API Contracts - OpenAPI specification

📊 Current Project Status

Progress: 32/39 MVP Phase 1 tasks completed (82%)

Last Updated: 2025-11-01

✅ Completed (32 tasks)

  • Foundation Setup (T001-T005): 5 tasks - Project structure, dependencies, tools
  • Database Layer (T006-T014): 9 tasks - PostgreSQL schema, models, seed data
  • Authentication (T015-T019): 5 tasks - NextAuth.js with enhanced security
  • API Endpoints (T020-T025): 6 tasks - Menu, delivery, user profile APIs
  • Essential UI (T026-T031, T033): 7 tasks - Components with mock data, mobile-first design

🔄 Remaining MVP Phase 1 (7 tasks)

  • Bundle System (T026.5-T029.5): 4 tasks - Subscription model and deadline management
  • Admin Dashboard (T032): 1 task - Order management interface
  • Content Pages (T034-T035): 2 tasks - Critical business and legal pages

📋 Implementation Stats

  • API Routes: 20 implemented
  • React Components: 45 components
  • Test Suites: 11 test files

🎯 Next Priorities

  1. Bundle system implementation (T026.5-T029.5)
  2. Admin panel for order management (T032)
  3. Critical content pages (T034-T035)
  4. Phase 2: Advanced subscription features

🎯 Business Context

Revenue Transformation

FitBox is implementing a bundle-first subscription model to increase Average Order Value from $17-25 to $85-140 (300-400% uplift).

Key Features:

  • Bundle sizes: 6/8/10/12 meals with 5% subscription discount
  • Smart deadline management (Tuesday/Saturday 6PM)
  • Auto-default meal selection for missed deadlines
  • Greater Vancouver Area delivery (Sunday/Wednesday)

Technical Stack

  • Frontend: Next.js 14, TypeScript, shadcn/ui, Tailwind CSS
  • Backend: PostgreSQL, Prisma ORM, NextAuth.js, Stripe
  • Testing: Jest, Playwright E2E, TDD methodology
  • Deployment: Vercel with production-ready configuration

🛠️ Development Workflow

Getting Started

# Quick start
npm install
npm run dev

# Check current progress
npm run tasks:status

# See what to work on next
npm run tasks:next

Documentation Updates

When updating documentation:

  1. Keep README.md current with latest project status
  2. Update task progress in specifications/tasks.md
  3. Maintain cross-references between related documents
  4. Test documentation links to ensure they work

Quality Standards

  • TDD Methodology: Contract tests first, implementation second
  • Real Database Testing: PostgreSQL integration, not mocks
  • Mobile-First Design: All UI optimized for mobile experience
  • Security by Default: Enhanced authentication, input validation

📞 Support & Resources

Internal Resources

External Resources

Development Commands

# Development
npm run dev                 # Start development server
npm run build              # Build for production

# Database
npm run db:reset           # Reset and reseed database
npm run db:studio          # Open Prisma Studio

# Testing
npm run test               # Unit tests
npm run test:e2e           # End-to-end tests
npm run test:coverage      # Coverage report

# Code Quality
npm run lint               # ESLint checking
npm run type-check         # TypeScript validation

# Task Management
npm run tasks:status       # View progress
npm run tasks:next         # See next tasks
npm run tasks:complete     # Mark tasks complete

📈 Documentation Improvements

This reorganization achieves:

  • 50% faster navigation with clear directory structure
  • Single source of truth for each type of information
  • Clear onboarding path for new team members
  • Maintainable structure that scales with project growth
  • Cross-referenced content for better discoverability

Last Updated: September 16, 2025 Next Review: When MVP Phase 2 begins (API implementation complete)