Restaurant Equis is a complete web-based management system designed to run every aspect of a restaurant operation — from taking orders at the counter to tracking inventory in the warehouse. It combines a React frontend with a FastAPI backend and PostgreSQL database, and ships with a Swagger-powered API and Docker-ready deployment.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.
Quick Start
Run the full stack locally in minutes — frontend, backend, and database.
System Architecture
Understand how the React frontend, FastAPI backend, and PostgreSQL database connect.
API Reference
Explore all REST endpoints with request/response schemas and examples.
Modules
POS, Kitchen, Orders, Inventory, Suppliers, and Reports — one guide per module.
System Modules
Restaurant Equis is organized into six role-based modules, each serving a different part of the restaurant team.POS — Caja
Cashier-facing order entry with cart, pricing, and WhatsApp sharing.
Kitchen Display
Cook-facing live order queue with one-tap status updates.
Orders
Full order history with filtering, detail view, and cancel support.
Inventory
Stock tracking with minimum-level alerts and reorder points.
Suppliers
Supplier directory with RIF, contact, and location information.
Reports
KPI dashboard with revenue trends, order counts, and CSV export.
Get Running in 3 Steps
Start the backend
Configure your PostgreSQL connection in
backend/.env, then run uvicorn main:app --reload --port 5000 from the backend/ directory.Start the frontend
Set
VITE_API_URL=http://localhost:5000 in .env.local and run npm run dev. Open http://localhost:3000.The interactive Swagger UI is available at
/api/docs once the backend is running. All endpoints are documented there with live request/response examples.