https://github.com/baoduong254/qrmeal
A modern, full-stack QR code-based restaurant ordering system that enables contactless dining experiences
https://github.com/baoduong254/qrmeal
fastify nextjs sqlite
Last synced: 3 months ago
JSON representation
A modern, full-stack QR code-based restaurant ordering system that enables contactless dining experiences
- Host: GitHub
- URL: https://github.com/baoduong254/qrmeal
- Owner: BaoDuong254
- License: mit
- Created: 2025-09-04T15:41:48.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-12-21T07:50:36.000Z (7 months ago)
- Last Synced: 2025-12-22T07:56:32.659Z (7 months ago)
- Topics: fastify, nextjs, sqlite
- Language: TypeScript
- Homepage: https://qrmeal.ticklab.site
- Size: 8.59 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# QRMeal
A modern restaurant management system with QR code-based ordering for guests. Built as a full-stack monorepo application enabling seamless table management, order processing, and real-time updates for restaurant operations.
## ✨ Features
- 🔐 **Authentication & Authorization** - JWT-based auth for staff and guest access
- 👥 **User Roles** - Distinct interfaces for Owner, Employee, and Guest
- 📱 **QR Code Ordering** - Guests scan table QR codes to browse menu and place orders
- 🍽️ **Menu Management** - Dynamic dish management with status tracking (Available/Unavailable/Hidden)
- 📋 **Order Processing** - Real-time order tracking with multiple statuses (Pending, Processing, Delivered, Paid, Rejected)
- 🪑 **Table Management** - Table capacity, status monitoring, and guest assignment
- 💬 **Real-time Updates** - Socket.IO for live order notifications and status changes
- 📊 **Dashboard** - Comprehensive analytics for revenue, orders, and popular dishes
- 🖼️ **Media Management** - Image upload and management for dishes
- 🐳 **Docker Support** - Containerized deployment with Docker Compose
- 🌐 **Internationalization** - Multi-language support (English & Vietnamese)
## 📋 Table of Contents
- [QRMeal](#qrmeal)
- [✨ Features](#-features)
- [📋 Table of Contents](#-table-of-contents)
- [🛠 System Requirements](#-system-requirements)
- [🚀 Project Installation](#-project-installation)
- [Clone repository](#clone-repository)
- [Install dependencies](#install-dependencies)
- [Removing packages](#removing-packages)
- [Update packages](#update-packages)
- [🏃♂️ Running the Project](#️-running-the-project)
- [Development mode](#development-mode)
- [Production build](#production-build)
- [🔄 Git Workflow](#-git-workflow)
- [Commit Message Convention](#commit-message-convention)
- [Hooks](#hooks)
- [Branch Naming](#branch-naming)
- [Standard Workflow](#standard-workflow)
- [📜 Available Scripts](#-available-scripts)
- [Root level](#root-level)
- [Client](#client)
- [Server](#server)
- [Prisma](#prisma)
## 🛠 System Requirements
- Node.js >= 24.11.1
- pnpm >= 10.26.1
- Git
If you don't have pnpm installed, you can install it using one of the following methods:
**Using npm:**
```bash
npm install -g pnpm
```
For more installation options, visit [pnpm installation guide](https://pnpm.io/installation).
## 🚀 Project Installation
### Clone repository
```bash
git clone https://github.com/BaoDuong254/QRMeal.git
cd QRMeal
```
### Install dependencies
The project uses pnpm workspaces. Simply run from the root directory:
```bash
pnpm install
```
This will install all dependencies for root, client, and server automatically.
**Install package for specific workspace:**
```bash
# For client
pnpm add --filter client
# For server
pnpm add --filter server
```
**Install dev dependencies:**
```bash
# For client
pnpm add -D --filter client
# For server
pnpm add -D --filter server
# For root
pnpm add -D -w
```
**Examples:**
```bash
# Install axios for client
pnpm add axios --filter client
# Install express types for server
pnpm add -D @types/express --filter server
# Install husky for root workspace
pnpm add -D husky -w
```
### Removing packages
```bash
# Remove from client
pnpm remove --filter client
# Remove from server
pnpm remove --filter server
# Remove from root
pnpm remove -w
```
### Update packages
```bash
# Update specific package
pnpm update
# Update all packages
pnpm update
# Update packages for specific workspace
pnpm update --filter client
```
## 🏃♂️ Running the Project
### Development mode
The project uses Turbo for monorepo management. Run both client and server simultaneously:
```bash
# From root directory - runs both client and server in parallel
pnpm dev
```
Or run them separately:
```bash
# Terminal 1 - Run server only
cd server
pnpm dev
# Terminal 2 - Run client only
cd client
pnpm dev
```
### Production build
```bash
# Build all packages from root
pnpm build
# Or build individually
cd client
pnpm build
pnpm start # Preview production build
cd server
pnpm build
pnpm start # Start production server
```
## 🔄 Git Workflow
### Commit Message Convention
The project uses [Conventional Commits](https://www.conventionalcommits.org/):
```bash
[optional scope]:
[optional body]
[optional footer(s)]
```
**Types:**
- `feat`: New feature
- `fix`: Bug fix
- `docs`: Documentation update
- `style`: Formatting changes that don't affect code logic
- `refactor`: Code refactoring
- `perf`: Performance improvement
- `test`: Adding or fixing tests
- `chore`: Build tasks, package manager configs, etc.
**Examples:**
```bash
git commit -m "feat(auth): add user login functionality"
git commit -m "fix(api): resolve user data fetching issue"
git commit -m "docs: update installation guide"
git commit -m "style(client): format code with prettier"
```
### Hooks
The project has built-in git hooks to ensure code quality:
- **pre-commit**: Run lint and format code
- **commit-msg**: Check commit message format
### Branch Naming
- `main`: Production branch
- `feature/feature-name`: For new features
- `bugfix/bug-description`: For bug fixes
- `hotfix/issue-description`: For urgent production issues
### Standard Workflow
1. **Create a new branch**
Always branch off from the latest version of `main`.
```bash
git checkout main
git pull origin main
git checkout -b feature/your-feature-name
```
2. **Work on your feature**
Make your code changes and commit them using the [Conventional Commits](https://www.conventionalcommits.org/) format:
```bash
git add .
git commit -m "feat(auth): add login functionality"
```
3. **Rebase with the latest main branch**
Before pushing, make sure your branch is up to date with `main`:
```bash
git fetch origin
git rebase origin/main
```
4. **Push your branch to remote**
```bash
git push origin feature/your-feature-name
```
5. **Create a Pull Request (PR)**
Open a PR to merge your branch into `main` using the project’s PR template.
Wait for review and approval before merging.
6. **After Merge — Sync and Clean Up**
Once your PR is merged:
```bash
git checkout main
git pull origin main
git branch -d feature/your-feature-name # delete local branch
git push origin --delete feature/your-feature-name # delete remote branch
```
## 📜 Available Scripts
### Root level
```bash
pnpm prepare # Setup husky hooks
pnpm dev # Run both client and server in development mode (parallel)
pnpm build # Build both client and server
pnpm start # Start both client and server (parallel)
pnpm lint # Run linting for all packages
pnpm lint:fix # Fix linting errors for all packages
pnpm format # Check code formatting for all packages
pnpm format:fix # Auto-format code for all packages
pnpm clean # Clean build artifacts for all packages
```
### Client
```bash
pnpm dev # Start development server
pnpm build # Build for production
pnpm start # Preview production build
pnpm lint # Check for linting errors
pnpm lint:fix # Fix auto-fixable linting errors
pnpm format # Check code formatting
pnpm format:fix # Auto-format code
pnpm clean # Clean build artifacts
```
### Server
```bash
pnpm dev # Start development server with nodemon
pnpm build # Build TypeScript to JavaScript
pnpm start # Start production server
pnpm debug # Start server in debug mode
pnpm lint # Check for linting errors
pnpm lint:fix # Fix auto-fixable linting errors
pnpm format # Check code formatting
pnpm format:fix # Auto-format code
pnpm clean # Clean build artifacts
```
### Prisma
```bash
cd server
# Generate Prisma client
pnpm exec prisma generate
# Push schema changes without migrations
pnpm exec prisma db push
# Open Prisma Studio (database GUI)
pnpm exec prisma studio
```