From c29701efdea990bb4e8f0c2dd11073ac34bfbadb Mon Sep 17 00:00:00 2001 From: EidanThen Date: Wed, 6 May 2026 22:31:29 +0000 Subject: [PATCH] Actualizar README.md --- README.md | 108 +++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 99 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a36934d..8a333ea 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,106 @@ -# React + Vite +# Comparador de Nómina vs TSS -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. +Aplicación web para comparar planillas de empleados contra los datos de la **TSS (Tesorería de la Seguridad Social)** y detectar empleados que **no están registrados correctamente**. -Currently, two official plugins are available: +## Descripción -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Oxc](https://oxc.rs) -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) +Este proyecto permite validar la consistencia entre: -## React Compiler +- Datos oficiales de la TSS (desde Google Sheets) +- Una o dos planillas de nómina (desde Google Drive) -The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation). +El sistema identifica si los empleados en las planillas: +- Están en la TSS +- No están en la TSS -## Expanding the ESLint configuration +Además, permite exportar los resultados a Excel. -If you are developing a production application, we recommend using TypeScript with type-aware lint rules enabled. Check out the [TS template](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) for information on how to integrate TypeScript and [`typescript-eslint`](https://typescript-eslint.io) in your project. +--- + +## Funcionalidades + +- Comparación de empleados entre TSS y planillas +- Soporte para: + - 1 planilla + - 2 planillas (ej: quincena 1 y quincena 2) +- Visualización en tabla con estado: + - 🟢 Sí (presente) + - 🔴 No (no presente) +- Exportación a Excel +- Validación de campos +- Modal con instrucciones de uso + +--- + +## Entradas requeridas + +El sistema utiliza 3 campos: + +1. **Google Sheets TSS URL** +2. **Primera Planilla URL (opcional)** +3. **Segunda Planilla URL (opcional)** + +⚠️ Debes ingresar: +- Siempre la TSS +- Al menos una planilla + +--- + +## Salida + +- Tabla con resultados +- Archivo Excel descargable: + comparacion_planillas.xlsx + +--- + +## Tecnologías utilizadas + +- React +- Bootstrap +- SheetJS (XLSX) +- Webhook/API (n8n u otro backend) + +--- + +## Configuración + +### Variables de entorno + +Crea un archivo `.env`: + +VITE_WEBHOOK_URL=https://tu-webhook-aqui + +--- + +## Ejecutar + +npm install +npm run dev + +--- + +## Cómo funciona + +1. Empleado ingresa enlaces +2. Se envían al backend +3. Se comparan datos +4. Se devuelve resultado +5. Se muestra en tabla + +--- + +## Cómo usar + +1. Sube el Excel de la TSS a Google Sheets +2. Copia el enlace +3. Sube planillas a Google Drive +4. Pega enlaces +5. Click en "Comparar" +6. Descarga resultados + +--- + +## ⚠️ Notas + +- Los enlaces deben ser públicos \ No newline at end of file