Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/AbyssDevs/CUSCATLECO/llms.txt

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

Esta guía te lleva desde cero hasta tener CUSCATLECO funcionando en tu máquina. Sigue los pasos en orden: primero verifica los requisitos, luego clona el repositorio, configura la base de datos e inicia el servidor.

Requisitos previos

Antes de comenzar, asegúrate de tener instalado lo siguiente en tu sistema:
  • Node.js — Versión LTS recomendada. Descárgalo desde nodejs.org.
  • Git — Para clonar el repositorio. Descárgalo desde git-scm.com.
  • MySQL — Servidor de base de datos relacional. Versión 8.x o superior recomendada.
Puedes verificar que cada herramienta está instalada ejecutando node -v, git --version y mysql --version en tu terminal.

Instalación

1

Clona el repositorio

Abre una terminal, navega a la carpeta donde quieres instalar el proyecto y ejecuta:
git clone https://github.com/AbyssDevs/CUSCATLECO.git
Esto descarga el código fuente completo en una carpeta llamada CUSCATLECO.
2

Instala las dependencias

Entra a la raíz del proyecto e instala los paquetes de Node.js:
cd CUSCATLECO
npm install
npm instalará Express, mysql2, bcrypt, express-session, multer y el resto de dependencias definidas en package.json.
3

Configura la base de datos

Abre el cliente de MySQL como usuario con privilegios suficientes y ejecuta los siguientes comandos para crear la base de datos e importar el esquema:
CREATE DATABASE IF NOT EXISTS cuscatleco;
USE cuscatleco;
Luego importa el archivo schema.sql incluido en la raíz del proyecto:
mysql -u root -p cuscatleco < schema.sql
El archivo schema.sql crea todas las tablas necesarias (roles, permisos, usuarios, mesas, platillos, pedidos, facturas) y registra el usuario administrador inicial.
4

Inicia el servidor

Desde la raíz del proyecto, ejecuta:
npm start
El servidor arranca en el puerto 3000. Deberías ver en la terminal:
Servidor corriendo en http://localhost:3000
Abre esa URL en tu navegador para ver el login
5

Abre la aplicación en el navegador

Navega a la siguiente dirección en tu navegador:
http://localhost:3000
Verás la pantalla de inicio de sesión de CUSCATLECO.

Credenciales iniciales

El esquema de base de datos incluye un usuario administrador preconfigurado para el primer acceso:
CampoValor
Correoadmin@saborcuscatleco.com
Contraseña123
Cambia la contraseña del administrador inmediatamente después del primer inicio de sesión. La contraseña predeterminada 123 es pública y representa un riesgo de seguridad en cualquier entorno que no sea estrictamente local.

Duración de la sesión

Las sesiones de usuario tienen una duración máxima de 30 minutos de inactividad. Transcurrido ese tiempo, el sistema cierra la sesión automáticamente y redirige al usuario a la pantalla de inicio de sesión. El temporizador se reinicia con cada petición al servidor, por lo que la sesión se mantiene activa mientras el usuario interactúa con la aplicación.
Para cerrar la sesión manualmente en cualquier momento, accede a la ruta /logout. El servidor destruye la sesión activa y redirige al login.

Próximos pasos

Con el sistema instalado y en marcha, puedes explorar las funcionalidades disponibles según tu rol:

Introducción

Revisa la descripción general del sistema, el stack tecnológico y los roles disponibles.

Roles y acceso

Conoce en detalle qué puede hacer cada rol dentro de CUSCATLECO.

Build docs developers (and LLMs) love