tableeee-v3 / README.md
Shyamnath's picture
Fix short_description length for Hugging Face metadata
eedc4b2
metadata
title: Tabble-v3 Restaurant Management
emoji: 🍽️
colorFrom: blue
colorTo: purple
sdk: docker
app_port: 7860
pinned: false
license: mit
short_description: Restaurant management with QR ordering & analytics
tags:
  - restaurant
  - management
  - fastapi
  - qr-code
  - ordering
  - analytics
  - multi-database

🍽️ Tabble-v3 Restaurant Management System

A comprehensive restaurant management system built with FastAPI and modern web technologies, featuring QR code-based table ordering, real-time order management, and multi-database support for independent hotel operations.

πŸš€ Live Demo

This application is deployed on Hugging Face Spaces with Docker. Try all the features:

  • 🏠 Home Interface: Complete system overview
  • πŸ‘₯ Customer Ordering: QR code-based table ordering system
  • πŸ‘¨β€πŸ³ Chef Dashboard: Real-time kitchen order management
  • 🏨 Admin Panel: Complete restaurant control and analytics

πŸ”‘ Demo Credentials

  • Hotel Access Code: myhotel
  • Demo Database: tabble_new.db
  • Table Numbers: 1-20
  • Phone OTP: Any 6 digits (demo mode)

✨ Key Features

🍽️ Customer Experience

  • QR Code Ordering: Scan table QR codes for instant menu access
  • Phone OTP Authentication: Secure Firebase-based login
  • Real-time Cart: Live cart updates with special offers
  • Payment Integration: Secure payment processing with loyalty discounts
  • Order History: Track past orders and preferences

πŸ‘¨β€πŸ³ Kitchen Operations

  • Real-time Notifications: Instant order alerts for chefs
  • Order Management: Accept, prepare, and complete orders
  • Status Updates: Live status changes across all interfaces
  • Kitchen Analytics: Track preparation times and efficiency

🏨 Restaurant Management

  • Multi-Database Support: Independent hotel operations
  • Complete Admin Panel: Full restaurant control
  • Menu Management: Add, edit, and manage dishes with images
  • Analytics Dashboard: Customer behavior and sales insights
  • Loyalty Programs: Configurable visit-based discounts
  • Table Management: Monitor occupancy and status

πŸ› οΈ Technology Stack

  • Backend: FastAPI 0.104.1 with Python 3.11
  • Database: SQLite with SQLAlchemy ORM
  • Authentication: Firebase Admin SDK
  • Templates: Jinja2 with Bootstrap 5
  • Deployment: Docker on Hugging Face Spaces
  • Architecture: RESTful API with middleware patterns

πŸ”§ Quick Start

Using the Demo

  1. Access the Application: Visit the Hugging Face Spaces URL
  2. Choose Interface: Select Customer, Chef, or Admin from the home page
  3. Customer Login: Use hotel code myhotel and any table number
  4. Explore Features: Try ordering, kitchen management, or admin controls

Local Development

# Clone the repository
git clone <repository-url>
cd tabble-v3

# Install dependencies
pip install -r requirements.txt

# Run locally
python run.py

πŸ“± Interface Guide

Customer Interface (/customer)

  1. Select hotel and enter access code
  2. Choose table number
  3. Enter phone number for OTP verification
  4. Browse menu and place orders
  5. Track order status in real-time

Chef Dashboard (/chef)

  1. View live order notifications
  2. Accept and manage incoming orders
  3. Update order status (cooking, ready, completed)
  4. Monitor kitchen performance metrics

Admin Panel (/admin)

  1. Complete restaurant management
  2. Add and edit menu items
  3. Configure pricing and offers
  4. View analytics and reports
  5. Manage hotel settings

πŸ—„οΈ Multi-Database Architecture

Each hotel operates with its own SQLite database:

β”œβ”€β”€ tabble_new.db          # Demo hotel database
β”œβ”€β”€ your_hotel.db          # Your hotel database
└── another_hotel.db       # Additional hotel database

Features:

  • Complete data isolation between hotels
  • Independent menu and pricing
  • Separate customer databases
  • Individual analytics and reports

πŸ” Security Features

  • Firebase Authentication: Secure phone OTP verification
  • Database Protection: Password-protected hotel access
  • Session Management: Secure session handling
  • CORS Configuration: Properly configured for web access
  • Data Isolation: Complete separation between hotel data

πŸ“Š Analytics & Reporting

  • Customer Analytics: Behavior insights and visit patterns
  • Sales Reports: Revenue tracking and trends
  • Dish Performance: Menu item popularity metrics
  • Kitchen Efficiency: Order processing analytics
  • Custom Reports: PDF generation for business intelligence

🎯 Use Cases

Small Restaurants

  • Single database operation
  • QR code table ordering
  • Basic order management
  • Customer analytics

Hotel Chains

  • Multi-database architecture
  • Independent hotel operations
  • Centralized management
  • Brand consistency

Food Courts

  • Multiple vendor support
  • Shared customer interface
  • Individual kitchen dashboards
  • Unified payment processing

πŸš€ Deployment

This application is containerized with Docker and optimized for Hugging Face Spaces:

  • Port: 7860 (Hugging Face Spaces standard)
  • Build: Automatic Docker build from repository
  • Environment: Python 3.11-slim with all dependencies
  • Database: Auto-initialized with demo data

πŸ“– API Documentation

Once deployed, explore the interactive API documentation:

  • Swagger UI: /docs
  • ReDoc: /redoc
  • Health Check: /health

🀝 Contributing

This is an open-source project. Contributions are welcome!

  1. Fork the repository
  2. Create your feature branch
  3. Commit your changes
  4. Push to the branch
  5. Create a Pull Request

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ”— Links

  • Documentation: Comprehensive API docs available at /docs
  • GitHub: Repository with full source code
  • Demo: Live demo with sample data
  • Support: Issues and discussions on GitHub

Ready to transform your restaurant operations? Start exploring the demo now! πŸš€πŸ½οΈ