Pasos para ejecución local de Proyecto Distribuidora

Sistema de gestión para distribuidora con arquitectura NestJS en el backend y React (Vite + TypeScript) en el frontend.

Requisitos Previos

Asegúrate de tener instalado en tu máquina:

• Node.js (v20 o superior)
• Yarn (npm install -g yarn)
• Docker y Docker Compose (para levantar la base de datos MySQL)

---

Guía Rápida para Levantar en Local

Paso 1: Base de Datos (MySQL)

Levantá el contenedor de MySQL utilizando Docker Compose desde la carpeta del backend:

cd backend/proyecto
docker-compose up -d mysql

• Host: localhost
• Puerto mapeado local: 3310 (interno del contenedor 3306)
• phpMyAdmin (Opcional): Accedé a http://localhost:8081 ejecutando docker-compose up -d

---

Paso 2: Backend (NestJS)

1. Ingresá a la carpeta del backend:

   cd backend/proyecto
   

2. Instalá las dependencias:

   yarn install
   

3. Configurá las variables de entorno: Crea o verifica el archivo .env en la raíz de backend/proyecto/:

   DB_PORT=3310
   DB_HOST="localhost"
   DB_USERNAME=
   DB_PASSWORD=
   DB_DATABASE=
   
   PORT=3000
   DB_TYPE="mysql"
   DB_SSL=
   JWT_SECRET=
   JWT_EXPIRATION_ACCESS=
   JWT_EXPIRATION_REFRESH=
   PUNTO_VENTA_ACTIVO_ID=
   

4. Ejecutá las migraciones de la Base de Datos:

   yarn migration:run

5. Ejecutá el Seed para poblar la Base de Datos: Esta función se ejecuta a partir de un endpoint usando curl

   curl http://localhost:3000/api/seed-all/execute
   

6. Levantar el Backend:

   yarn start:dev
   

---

Paso 3: Frontend (React + Vite)

1. En una nueva terminal, ingresá a la carpeta del frontend:

   cd frontend
   

2. Instalá las dependencias:

   yarn install
   

3. Verificá las variables de entorno: Asegúrate de que el archivo .env.development contenga:

   VITE_API_URL="http://localhost:3000/api"
   

4. Levantá el servidor de desarrollo:

   yarn dev
   

   El frontend estará disponible en http://localhost:5173. Verificar el acceso al panel del admin con las credenciales de abajo

---

Credenciales de Acceso por Defecto

Una vez ejecutado el Seed, podés ingresar al sistema desde http://localhost:5173/login:

• Correo: [email protected]
• Contraseña: 12345678
• Empresa: Seleccionar la empresa generada en el menú desplegable.

---

Pruebas y Testing

Backend

• Ejecutar tests unitarios: cd backend/proyecto && yarn test
• Ver cobertura de código: cd backend/proyecto && yarn test:cov
• Ejecutar tests E2E: cd backend/proyecto && yarn test:e2e

Frontend

• Verificar linter de sintaxis: cd frontend && yarn lint
• Checklist de pruebas manuales: Ver guía completa en frontend/TESTING_CHECKLIST.md.

---

Estructura del Repositorio

.
├── backend/
│   └── proyecto/          # API Rest NestJS (TypeORM, Auth JWT, MySQL)
├── frontend/              # Aplicación Web React (Vite, Tailwind, TypeScript)
└── README.md              # Documentación principal del proyecto