Files
cruce-cuentas-glm/README.md
T

47 lines
1.8 KiB
Markdown

# Cruce de Cuentas GLM
Sistema de conciliación de cuentas entre registros bancarios, nómina y BambooHR.
## Descripción
Este proyecto es una interfaz frontend profesional diseñada para gestionar el proceso de cruce de cuentas (reconciliación) de GLM. Permite cargar archivos, ejecutar el motor de conciliación a través de n8n y visualizar los resultados e irregularidades detectadas.
## Requisitos
- Node.js (v18 o superior recomendado)
- npm o yarn
- Acceso a la instancia de n8n configurada
## Cómo instalar
1. Clonar el repositorio.
2. Ejecutar la instalación de dependencias:
```bash
npm install
```
## Cómo correr en local
1. Asegúrate de tener el archivo `.env` configurado (puedes basarte en `.env.example`).
2. Inicia el servidor de desarrollo:
```bash
npm run dev
```
3. Abre [http://localhost:5173](http://localhost:5173) en tu navegador.
## Cómo generar build
Para generar la versión de producción:
```bash
npm run build
```
Los archivos optimizados se generarán en la carpeta `dist/`.
## Variables de Entorno Requeridas
El proyecto requiere las siguientes variables en un archivo `.env`:
- `VITE_FIREBASE_API_KEY`: API Key de Firebase.
- `VITE_FIREBASE_AUTH_DOMAIN`: Dominio de autenticación.
- `VITE_FIREBASE_PROJECT_ID`: ID del proyecto Firebase.
- `VITE_FIREBASE_STORAGE_BUCKET`: Bucket de almacenamiento.
- `VITE_FIREBASE_MESSAGING_SENDER_ID`: ID del remitente de mensajería.
- `VITE_FIREBASE_APP_ID`: ID de la aplicación Firebase.
- `VITE_WEBHOOK_URL`: URL del webhook de n8n para procesar el cruce.
## Nota de Seguridad
**IMPORTANTE:** Nunca subas el archivo `.env` o cualquier archivo con credenciales reales al repositorio. El archivo `.gitignore` está configurado para excluir archivos sensibles. Solo comparte `.env.example` con los nombres de las variables necesarias.