Modern platform for creating digital menus for restaurants with QR codes

🇷🇺 Русский | 🇬🇧 English

API (Koyeb): https://fat-cherlyn-chatman-d593e748.koyeb.app

Web App (Vercel): https://qr-asia-web.vercel.app

Admin Panel (Vercel): https://qr-asia-admin.vercel.app

💡 See PRODUCTION.md for detailed deployment info and monitoring links.

QR Menu Platform is a full-featured digital menu management system for restaurants. The platform allows restaurant owners to easily create multilingual menus, generate QR codes, and track analytics.

• 🌐 Multilingual Support: 5 languages (EN, TH, RU, CN, AR)
• 📱 QR Codes: Generation with Vercel Blob Storage and scan tracking
• 🖼️ Image Upload: Vercel Blob Storage + automatic resizing (4 versions)
• 📊 Full CRUD: Restaurants, categories, menu items
• 🎨 Modern UI: Built with Next.js 16 + shadcn/ui + Tailwind CSS
• ⚡ Fast Backend: Bun.js + PostgreSQL (25+ API endpoints)
• 🔐 Security: JWT access tokens (1h) + refresh tokens (7d) with automatic rotation
• 📱 Responsive Design: Sidebar navigation on desktop, mobile-first
• ✅ Testing: E2E tests with Playwright (195 tests)
• 🚀 CI/CD: GitHub Actions with automated testing

• Bun 1.0+
• PostgreSQL (or Neon database)
• Vercel Blob Storage token (for image upload in production)

# Clone repository
git clone <repository-url>
cd qr-menu-platform

# Install dependencies
bun install

# Set up environment variables
cp apps/api/.env.example apps/api/.env
cp apps/admin/.env.example apps/admin/.env
cp apps/web/.env.example apps/web/.env

# Set up database
cd packages/database
bun run db:push
bun run db:seed

# Run all services
bun run dev

• 📱 Client Web App: http://localhost:3001
• 🎨 Admin Panel: http://localhost:3000
• 🔌 API: http://localhost:4004
• 🗄️ Database Studio: http://localhost:5555

Super Admin:
Email: superadmin@qr-menu.com
Password: password123

Admin:
Email: admin@qr-menu.com
Password: password123

Restaurant Owner:
Email: owner@example.com
Password: password123

qr-menu-platform/
├── apps/
│   ├── web/          # Next.js client application (port 3001)
│   ├── admin/        # Next.js admin panel (port 3000)
│   └── api/          # Bun.js API server (port 4004)
├── packages/
│   ├── database/     # Prisma schema + migrations
│   ├── ui/           # Reusable components
│   ├── types/        # Shared TypeScript types
│   └── utils/        # Utilities and helper functions
└── docs/
    ├── en/           # English documentation
    └── ru/           # Russian documentation

• Framework: Next.js 16.0.1 (App Router)
• Library: React 19.2.0
• Language: TypeScript 5.9.3
• Styling: Tailwind CSS 4.0
• UI Components: shadcn/ui (Radix UI)
• Forms: React Hook Form + Zod 4.1
• HTTP Client: Fetch API

• Runtime: Bun.js 1.3.1
• HTTP Server: Bun.serve()
• Database: PostgreSQL (Neon with connection pooling)
• ORM: Prisma 6.0+
• Authentication: JWT access tokens (1h) + refresh tokens (7d) + SHA-256 hashing
• Storage: Vercel Blob Storage with fallback to local storage
• Image Processing: Sharp (4 versions: thumbnail, small, medium, large)
• QR Codes: qrcode library with upload to Vercel Blob

Detailed documentation is available in two languages:

• 📖 English Documentation
• 📖 Russian Documentation

• 📊 Project Status - current status (100%)
• ✅ Development Checklist - detailed task plan

Version: MVP v1.0 Overall Progress: 100% ✅

• Backend API - 100% (25+ endpoints)
  • ✅ Refresh token authentication with automatic rotation
  • ✅ JWT access tokens (1h) + refresh tokens (7d)
  • ✅ Device tracking (userAgent, ipAddress)
  • ✅ Restaurant CRUD with moderation
  • ✅ Menu CRUD (categories + items)
  • ✅ Image upload (Vercel Blob + Sharp, 4 versions)
  • ✅ QR code generation with upload to Vercel Blob
  • ✅ Analytics tracking
• Admin Panel - 100%
  • ✅ Login page with refresh token support
  • ✅ Dashboard with statistics
  • ✅ Restaurant management + moderation
  • ✅ Menu builder with drag & drop
  • ✅ Category and item management
  • ✅ Image upload (drag & drop, 5MB limit)
  • ✅ QR code generation and viewing
  • ✅ Analytics page
• Client Web App - 100%
  • ✅ Menu display by slug
  • ✅ Sidebar navigation by categories (desktop)
  • ✅ Horizontal category scrolling (mobile)
  • ✅ Language switcher (EN, TH, RU, CN, AR)
  • ✅ "Home" button for navigation
  • ✅ Responsive design (mobile-first)
  • ✅ Menu item cards with images
• Production Deployment - 100%
  • ✅ API on Koyeb (https://fat-cherlyn-chatman-d593e748.koyeb.app)
  • ✅ Web App on Vercel (https://qr-asia-web.vercel.app)
  • ✅ Admin Panel on Vercel (https://qr-asia-admin.vercel.app)
  • ✅ CI/CD via GitHub Actions
  • ✅ Automated testing
• Testing - 100%
  • ✅ E2E tests (195 tests)
  • ✅ Linting/Formatting (Biome)
  • ✅ GitHub Actions CI
• Documentation - 100%

• Analytics dashboard with charts
• Email notifications for owners
• Rate limiting for API endpoints
• Sentry error tracking
• WebSocket real-time updates
• PDF export for menus

The project uses Playwright for E2E testing.

# Run all tests
bun test

# Run in UI mode
bun test:ui

# By category
bun test:api      # API tests
bun test:admin    # Admin panel tests
bun test:web      # Web app tests

Current Test Status: 195 tests

• ✅ API tests: auth, restaurants, menu, upload, QR codes, analytics, dashboard, settings, admin access, public menu
• ✅ Admin tests: login, register, restaurants, settings, QR codes
• ✅ Web tests: menu, homepage

The project uses Biome for code linting and formatting.

# Check code (linting + formatting + imports)
bun run check

# Auto-fix
bun run check:fix

# Format only
bun run format:write

# Lint only
bun run lint:fix

Overall Progress: 100% ✅ (Backend 100%, Frontend 100%, Tests 100%, Docs 100%, Production 100%)

We welcome contributions! Please see Contributing Guide.

MIT License - see LICENSE for details.

Developed for restaurants in Thailand 🇹🇭

If you have questions or issues:

1. Check the documentation
2. Create an issue on GitHub
3. Contact support@example.com

Last Updated: 2025-11-05

New Features in v1.0:

• ✨ Refresh token authentication with automatic rotation
• 🌐 Arabic language support (5 languages)
• 📱 Sidebar navigation for menu categories
• 🏠 "Home" button for navigation
• 🚀 Production deployment with CI/CD

Made with ❤️ using Bun.js + Next.js 16