lime-restaurant System Requirements Document

Introduction

The "lime-restaurant" project is a modern QR-based restaurant ordering web application designed for "MRK Foods". This system aims to enhance the dining experience by allowing customers to scan a QR code at their table to access a digital menu, browse food items, add them to their cart, and place orders in real-time.

System Overview

The lime-restaurant system is designed to streamline the ordering process in a restaurant setting. Customers can use their smartphones to scan a QR code, which directs them to a digital menu. The application supports a seamless ordering experience with features like a categorized menu, live order tracking, and an intuitive user interface. The system also includes roles for an owner and admins to manage the restaurant's operations effectively.

Functional Requirements

• As a Customer, I should be able to scan a QR code to access the digital menu.
• As a Customer, I should be able to browse food items by categories such as BBQ, Burgers, Pizza, Drinks, and Desserts.
• As a Customer, I should be able to view food item details including image, name, price, and rating.
• As a Customer, I should be able to add items to my cart and adjust quantities.
• As a Customer, I should be able to see a live total price calculation in my cart.
• As a Customer, I should be able to place an order and receive a confirmation.
• As a Customer, I should be able to track my order status (Received → Preparing → Ready).
• As an Admin, I should be able to add and update menu items.
• As an Admin, I should be able to monitor and manage orders.
• As the Owner, I should have full access to manage admins, view reports, and configure system settings.

User Personas

• Owner: M Revanth Kumar, responsible for overall system management, admin oversight, and strategic decisions.
• Admin: Restaurant staff responsible for managing menu items, tracking orders, and ensuring smooth operations.
• Customer: Restaurant patrons who use the QR-based system to order food.

Visuals Colors and Theme

• primary: #1A1A2E (Deep Midnight Blue)
• primary_light: #16213E (Light Midnight Blue)
• secondary: #E94560 (Crimson Red)
• accent: #F9D342 (Vibrant Yellow)
• highlight: #FF6F61 (Coral)
• bg: #0F3460 (Dark Blue)
• surface: rgba(255, 255, 255, 0.1) (Glassmorphism Effect)
• text: #FFFFFF (White)
• text_muted: #B0B0B0 (Muted Gray)
• border: rgba(255, 255, 255, 0.2) (Subtle White)

Signature Design Concept

The homepage of the lime-restaurant web app will feature an interactive "Digital Dining Experience" concept. Upon scanning the QR code, users are greeted with a dynamic landing page that simulates a virtual restaurant table. Using @react-three/fiber and @react-three/drei, the table will appear in 3D, with menu categories represented as interactive objects (e.g., a pizza box for the Pizza category). Users can click on these objects to "open" them, revealing the menu items inside. The background will subtly shift colors using gsap to reflect the time of day, enhancing the dining ambiance. Hover effects will animate the objects slightly, inviting interaction, and clicking will trigger smooth transitions to the detailed menu view.

Interaction Model & Motion Direction

The landing page will employ a "parallax" interaction model, creating a layered depth effect as users scroll. Decorative elements like ambient lighting and floating particles will move at different speeds, providing a rich, immersive experience. The main content will scroll naturally, ensuring usability and accessibility. Internal pages, such as the menu and cart, will use an "animated" model with scroll-triggered reveals and hover transitions to maintain a polished, responsive feel.

Non-Functional Requirements

• The system must be highly responsive and mobile-first to accommodate various device sizes.
• The application should ensure fast load times and smooth transitions.
• The architecture must support scalability to handle increased traffic during peak hours.
• Security measures must be in place to protect user data and transactions.

Tech Stack

• Frontend: React for Web
• Backend: Python with FastAPI
• Database: MySQL or MariaDB, using Alembic for migrations
• AI Models: GPT 5.4 for user-friendly responses
• AI Tools: Litellm for LLM Routing
• Local Orchestration: Docker, docker-compose
• Server-side Orchestration: Kubernetes

Assumptions and Constraints

• The system assumes that customers have smartphones capable of scanning QR codes.
• The restaurant environment must support stable internet connectivity for real-time operations.
• The application will be deployed in a production environment with appropriate server resources.

Glossary

• QR Code: A machine-readable code used for accessing the digital menu.
• Glassmorphism: A design style that uses transparency and blur effects to create a frosted glass appearance.
• Parallax: A scrolling effect where background images move slower than foreground images, creating a sense of depth.
• Admin: A user role with permissions to manage menu items and orders.
• Owner: The primary user role with full system access and management capabilities.