MenuMaker - Restaurant Menu Management & Ordering System

Transform your kitchen into a business with verified launch-scope ordering, menu, payment, and operations workflows.

MenuMaker is a restaurant menu management and ordering platform for food entrepreneurs, home-based sellers, and cloud kitchens. Current launch readiness is governed by docs/product/status.md and the capability registry; historical phase guides are not release authority.

Current posture: local remediation/build evidence is green for launch-scope flows, but public production release still requires the live evidence listed in docs/product/status.md.

---

✨ Features

Launch-scope platform

• 🔐 Authentication - JWT-based auth with refresh tokens
• 🏪 Business Management - Multi-business support, custom slugs, settings
• 📋 Menu Builder - Intuitive drag-and-drop menu editor
• 🍽️ Dish Management - Categories, images, pricing, dietary tags
• 📦 Order Management - Real-time tracking, notifications, status updates
• 🌐 Public Menu Pages - SEO-optimized, shareable menu URLs
• 💳 Payment Processing - Stripe, Razorpay, PhonePe, Paytm, UPI, Manual
• 📊 Analytics - Revenue, orders, performance metrics
• 📱 WhatsApp Integration - Order confirmations via WhatsApp
• 🔒 GDPR Compliance - Cookie consent, data export/deletion
• 🔄 Reorder Flow - One-click reordering for customers
• 💰 Multiple Payment Processors - Connect Stripe, Razorpay, PhonePe, Paytm
• 💸 Automated Payouts - Configurable schedules (daily/weekly/monthly)
• 🌍 Multi-Language - Hindi, Tamil, Marathi with RTL layout support
• ⭐ Reviews & Complaints - Customer feedback, seller responses
• 🔍 Marketplace Discovery - Search, filter, featured sellers
• 🎟️ Coupons & Promotions - Discount codes, automatic promotions
• 🎁 Basic Referral Codes - Share/validate referral codes without reward or leaderboard claims
• 👥 Admin Portal - First-party /admin route for user management, moderation, support tickets, and feature readiness
• 🎨 Design System - Comprehensive UI component library, dark mode

Disabled until separately enabled and evidenced

These capabilities exist only as launch-gated or historical scope until the capability registry, provider credentials, privacy/security review, contract evidence, and smoke tests say otherwise:

• ⛔ OCR menu import
• ⛔ Paid subscription tiers, trials, upgrades, and billing portal flows
• ⛔ Enhanced referral rewards, leaderboards, affiliate payouts, and prize campaigns
• ⛔ Tax reporting / GST invoice generation
• ⛔ POS sync
• ⛔ Third-party delivery partner integrations

---

🚀 Quick Start

Prerequisites

• Node.js 20.x or higher
• PostgreSQL 15+
• Docker & Docker Compose (recommended)

1. Clone & Install

git clone https://github.com/ameedanxari/menumaker.git
cd menumaker

# Install dependencies
npm install
cd backend && npm install && cd ..
cd frontend && npm install && cd ..

2. Configure Environment

# Backend
cp backend/.env.example backend/.env
# Edit backend/.env with your database and API keys

# Frontend  
cp frontend/.env.example frontend/.env
# Edit frontend/.env with API URL

3. Start with Docker (Recommended)

docker-compose up -d

Access the application:

• Frontend: http://localhost:3000
• Backend API: http://localhost:3001
• API Docs: http://localhost:3001/api/docs

4. Or Start Manually

# Start backend
cd backend && npm run dev

# In new terminal, start frontend
cd frontend && npm run dev

---

📚 Documentation

• Governed docs entry point - Current architecture, operations, security, release, and product status.
• Product status - Evidence-backed release posture and remaining release blockers.
• Capability index - Source of truth for enabled/disabled capability state.
• Design-system state matrix - Cross-platform UI state authority.
• API Documentation - OpenAPI/Swagger docs (when running)

Historical root guides are inventoried in docs/governance/document-inventory.csv and are superseded by the governed docs tree unless explicitly listed as current.

---

🛠️ Tech Stack

Backend

• Runtime: Node.js 20.x
• Framework: Fastify 4.x (high-performance REST API)
• Language: TypeScript 5.x (strict mode)
• Database: PostgreSQL 15
• ORM: TypeORM (synchronize mode for development)
• Authentication: JWT with refresh tokens
• File Storage: S3-compatible (AWS S3, MinIO)
• Payments: Stripe, Razorpay, PhonePe, Paytm

Frontend

• Framework: React 18 with TypeScript
• Build Tool: Vite
• Routing: React Router v6
• State Management: Zustand
• Styling: Tailwind CSS 3 + Design Tokens
• UI Components: Custom library (20+ components)
• Dark Mode: Class-based with system preference

DevOps

• CI/CD: GitHub Actions (4 workflows)
• Testing: Jest, Vitest, Playwright
• Linting: ESLint + Prettier
• Containers: Docker & Docker Compose

---

📁 Project Structure

menumaker/
├── backend/                # Fastify API server
│   ├── src/
│   │   ├── config/        # Database, environment
│   │   ├── middleware/    # Auth, error handling
│   │   ├── models/        # TypeORM entities (41 models)
│   │   ├── routes/        # API endpoints (organized by feature)
│   │   ├── services/      # Business logic
│   │   └── main.ts        # Entry point
│   └── tests/             # Backend tests
├── frontend/              # React application
│   ├── src/
│   │   ├── components/    # Reusable UI components
│   │   ├── pages/         # Route pages (15+ pages)
│   │   ├── hooks/         # Custom React hooks
│   │   ├── stores/        # Zustand state
│   │   └── services/      # API client
│   ├── design-tokens.json # Design system tokens
│   └── tailwind.config.js # Tailwind config
├── specs/                 # Product specifications
├── .github/workflows/     # CI/CD pipelines
└── README.md              # This file

---

🧪 Testing

Backend Tests

cd backend

# Run tests
npm test

# With coverage
npm run test:coverage

# Watch mode
npm run test:watch

Frontend Tests

cd frontend

# Unit tests
npm test

# E2E tests
npm run test:e2e

# E2E with UI
npm run test:e2e:ui

Coverage Goals: Backend > 80%, Frontend > 70%

---

🚢 Deployment

Production Build

# Backend
cd backend
npm ci --production
npm run build
npm start

# Frontend
cd frontend
npm ci
npm run build
# Serve dist/ with nginx, caddy, or static file server

Docker Production

docker-compose -f docker-compose.prod.yml up -d

Environment Variables

Backend (.env):

NODE_ENV=production
DATABASE_URL=postgresql://user:pass@host:5432/menumaker
JWT_SECRET=your-secure-secret-min-64-chars
STRIPE_SECRET_KEY=sk_live_...
S3_BUCKET=menumaker-prod

Frontend (.env):

VITE_API_URL=https://api.yourdomain.com/api/v1

See .env.example for complete reference.

---

🔒 Security

• ✅ JWT authentication with refresh tokens
• ✅ bcrypt password hashing
• ✅ Rate limiting (100 requests/15min)
• ✅ CORS protection
• ✅ Helmet security headers
• ✅ SQL injection prevention (parameterized queries)
• ✅ XSS protection
• ✅ CSRF protection (JWT-based)
• ✅ Input validation (all endpoints)

Production Checklist:

• Use strong JWT_SECRET (64+ chars)
• Enable SSL/TLS
• Configure firewall rules
• Set up secrets management
• Enable 2FA for admin users
• Regular security audits

---

📊 Database

41 Entities organized by feature:

• Core: User, Business, Dish, Menu, Order (11 entities)
• Payments: Payment, Payout, PaymentProcessor (5 entities)
• Referrals & GDPR: Referral, CookieConsent, DeletionRequest (4 entities)
• Admin: AdminUser, SupportTicket, FeatureFlag, AuditLog (5 entities)
• Reviews: Review, ReviewResponse, ReviewReport (3 entities)
• Marketplace: SellerProfile, FeaturedSeller, SellerCategory (5 entities)
• Integrations: POSIntegration, DeliveryIntegration (5 entities)
• Promotions: Coupon, CouponUsage, AutomaticPromotion (3 entities)

Database Schema: Auto-generated by TypeORM (development uses synchronize: true)

Production: Generate migrations before deploying

npm run migration:generate -- -n InitialSchema
npm run migration:run

---

🌐 API Documentation

Interactive Docs: http://localhost:3001/api/docs (Swagger UI)

Key Endpoints:

• /api/v1/auth - Authentication
• /api/v1/businesses - Business management
• /api/v1/menus - Menu CRUD
• /api/v1/dishes - Dish management
• /api/v1/orders - Order processing
• /api/v1/payment-processors - Payment configuration
• /api/v1/payouts - Payout management
• /api/v1/marketplace - Seller discovery
• /api/v1/coupons - Promotions
• /api/v1/referrals - Basic referral-code sharing and validation
• /api/v1/admin - Admin backend (restricted)

Disabled route groups such as POS, delivery partner, OCR, tax reporting, subscriptions, and enhanced referrals are kept out of the public OpenAPI contract until enabled and evidenced.

---

🎨 Design System

MenuMaker includes a comprehensive design system:

Design Tokens

All design values defined in frontend/design-tokens.json:

• Colors: Primary (Orange), Secondary (Blue), Semantic colors
• Typography: Inter (sans), JetBrains Mono (mono)
• Spacing: 4px grid system
• Dark Mode: Full support with system preference

Components

20+ shared UI components:

• Atoms: Button, Input, Checkbox, Badge, Avatar
• Molecules: Card, Modal, Dropdown, Alert, Toast
• Organisms: Header, DataTable, Form

See COMPONENT-LIBRARY.md for details.

---

🤝 Contributing

1. Fork the repository
2. Create feature branch (git checkout -b feature/amazing-feature)
3. Commit changes (git commit -m 'feat: add amazing feature')
4. Push to branch (git push origin feature/amazing-feature)
5. Open Pull Request

Commit Convention: Conventional Commits

• feat: New feature
• fix: Bug fix
• docs: Documentation
• style: Formatting
• refactor: Code restructuring
• test: Tests
• chore: Maintenance

---

📝 License

MIT License - see LICENSE file

---

🙏 Support

• Issues: GitHub Issues
• Email: support@menumaker.app
• Documentation: Next Steps Guide

---

🎯 Project Status

Current status is evidence-backed in docs/product/status.md. Do not use “production ready” or advertise disabled capabilities unless the status page and capability registry have been updated with release evidence.

---

Built with ❤️ for food entrepreneurs worldwide

Transform your kitchen into a business. Start selling today.