Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/FloresJesus/SS_RESTAURANT/llms.txt

Use this file to discover all available pages before exploring further.

SS Restaurant is a full-stack management platform designed for restaurant operations. It provides a Vue 3 single-page application backed by an Express + MySQL API, covering every aspect of daily service — from taking orders at the table to generating end-of-day cash close reports.

Quick Start

Run the backend and frontend locally in under 5 minutes

Configuration

Environment variables, database setup, and ImageKit integration

Core Features

Orders, tables, reservations, billing, and reporting

API Reference

Full REST API documentation for every endpoint

What SS Restaurant Does

SS Restaurant manages the complete lifecycle of a restaurant’s daily operation through a role-aware dashboard accessible to four staff roles: admin, cajero (cashier), mesero (waiter), and cocina (kitchen).

Order Management

Create, update, and track orders through kitchen preparation to delivery

Tables & Reservations

Manage table status and handle advance reservations with auto table assignment

Menu Management

Organize products by category, toggle availability, and upload images via ImageKit

Billing

Process payments in four methods, generate tickets and tax invoices (facturas)

Reports

Generate 10 types of PDF reports from daily sales to cash close

Roles & Auth

JWT-based auth with per-route role enforcement across all endpoints

Getting Started

1

Clone the repository

git clone https://github.com/FloresJesus/SS_RESTAURANT.git
cd SS_RESTAURANT
2

Configure the backend environment

Create Backend/.env with your MySQL credentials and JWT secret. See Configuration for all variables.
3

Start the API server

cd Backend && npm install && node server.js
The Express API starts on port 3000 by default.
4

Start the frontend

cd Frontend && npm install && npm run dev
The Vue 3 SPA is served by Vite and proxies /api to the backend.
Two endpoints are publicly accessible without authentication: GET /api/public/menu for the digital menu and POST /api/public/reservations for online table booking. All other endpoints require a Bearer token obtained via POST /api/auth/login.

Build docs developers (and LLMs) love