Restaurant Equis is a full-stack restaurant management platform built to streamline every stage of a dining operation — from the moment a customer places an order at the point of sale through kitchen preparation, fulfillment, and end-of-day financial reporting. It targets small-to-medium restaurant teams who need a single cohesive tool that replaces disconnected spreadsheets, paper tickets, and standalone POS terminals. By unifying orders, inventory, supplier data, and KPI reporting under one web application, Restaurant Equis reduces operational errors, speeds up service, and gives management real-time visibility into restaurant performance.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/teofilobetancourt/Restaurant-Equis/llms.txt
Use this file to discover all available pages before exploring further.
Key Modules
POS — Point of Sale
Cashiers browse the menu catalogue, build an order cart, select table or delivery type, calculate totals, and dispatch orders to the kitchen — including a WhatsApp summary link for the customer.
Kitchen Display
Cooks see only the active orders queue in real time. They advance each ticket through Recibido → Preparando → Listo states and receive an audio alert on each new incoming order.
Orders & History
Supervisors access a full paginated order history, inspect ticket details, and cancel orders directly from the dashboard — with instant status propagation across all connected clients.
Inventory Management
Warehouse staff perform full CRUD on supply stock (insumos), set minimum thresholds and reorder points, and get automatic low-stock alerts when current stock drops below the configured minimum.
Suppliers Directory
The purchasing team maintains a searchable supplier directory with company name, RIF tax ID, city, phone, email, address, and contact person — all editable in-place.
Reports & KPIs
Management views revenue KPIs, order volume metrics, and filtered order reports — all exportable as CSV — to support daily and monthly business decisions.
Tech Stack
Restaurant Equis is built on a modern, pragmatic stack chosen for developer velocity and production reliability.Frontend
| Technology | Version | Role |
|---|---|---|
| React | 19 | Component-based UI framework |
| TypeScript | 5.x | Statically typed JavaScript superset |
| Vite | 6.x | Build tool and development server |
| Tailwind CSS | 4.x | Utility-first CSS framework |
| Lucide React | latest | SVG icon library |
| Motion | 12.x | Animation library |
src/api/index.ts, which acts as the sole API abstraction layer for every view component.
Backend
| Technology | Version | Role |
|---|---|---|
| Python | 3.11+ | Server-side language |
| FastAPI | 0.115+ | REST API framework — all /api/ endpoints |
| SQLAlchemy | 2.x | ORM — maps PostgreSQL tables to Python objects |
| Pydantic | 2.x | Automatic JSON validation and serialization |
| Uvicorn | 0.30+ | ASGI server running FastAPI on port 5000 |
| psycopg2-binary | 2.9+ | PostgreSQL adapter for Python |
ordenes, productos, inventario, proveedores, reportes) lives in its own router file under backend/routers/.
Database
PostgreSQL 15+ is the single source of truth for all restaurant data. Tables are created automatically via SQLAlchemy’sBase.metadata.create_all() on every backend startup — no manual migrations are required for development. The schema is split across two PostgreSQL schemas: the public schema holds the core restaurant operation tables and the Inventario schema holds supply-chain data.
Infrastructure
| Technology | Role |
|---|---|
| Nginx | Reverse proxy — serves the React SPA and forwards /api/* to FastAPI |
| systemd | Keeps the backend process alive and auto-restarts it on failure |
| Docker Compose | Spins up a PostgreSQL container for local development |
| Linux (Ubuntu/Debian) | VPS operating system |
User Roles
Restaurant Equis is designed for six distinct operational roles, each with a dedicated module view:- Cashiers use the POS view to take and dispatch customer orders.
- Cooks use the Kitchen display to track and advance the preparation state of every active ticket.
- Supervisors use the Orders view to monitor the full order history and cancel tickets when needed.
- Warehouse staff use the Inventory module to manage ingredient stock levels and reorder alerts.
- Purchasing use the Suppliers module to maintain the vendor directory.
- Management uses the Reports module to track KPIs, revenue, and export data for accounting.
An interactive Swagger UI documenting every API endpoint is available at
/api/docs on your running backend. Use it to explore request/response schemas and test calls directly from the browser. See the API Overview for the full endpoint list.