fix: Correción de documentación

This commit is contained in:
christian.julian 2025-06-20 13:39:18 -06:00
parent b8aaa87509
commit 73e5d3d574
1 changed files with 46 additions and 0 deletions

46
README.md Normal file
View File

@ -0,0 +1,46 @@
# Sistema de Registro y Gestión de Candidatos - LANIA
Este proyecto es una plataforma web desarrollada para automatizar el registro de usuarios en el **Centro de Certificación LANIA**, con el objetivo de optimizar la recolección de datos demográficos y de satisfacción de los candidatos, así como proporcionar herramientas de análisis al área de administración.
## ✨ Descripción General
La aplicación se compone de dos partes principales:
- **Web App**: Interfaz gráfica donde candidatos pueden llenar formularios y administradores pueden gestionar usuarios, candidatos y consultar datos analíticos.
- **API REST**: Servicio backend que expone endpoints para la gestión de candidatos, autenticación vía OAuth2 y exportación de datos en múltiples formatos (JSON, CSV, Excel).
## 🎯 Propósito
- Automatizar el proceso de registro y seguimiento de candidatos.
- Recolectar datos clave para la toma de decisiones institucionales.
- Facilitar la gestión de usuarios y candidatos por parte del personal de LANIA.
- Brindar herramientas visuales de análisis mediante un dashboard dinámico.
## 👥 Tipos de Usuario
- **Candidato**: Registra sus datos mediante formularios web.
- **Administrador LANIA**: Visualiza, filtra y exporta datos, administra usuarios y accede al dashboard analítico.
## 🛠 Tecnologías Utilizadas
| Tecnología | Propósito |
|-------------------|------------------------------------------------|
| PHP (MVC) | Lógica del servidor y API REST |
| JavaScript | Interacción dinámica en el cliente |
| MySQL | Almacenamiento de datos |
| Chart.js | Visualización de datos en gráficos |
| OAuth2 | Autenticación y autorización segura |
| HTML/CSS | Maquetación y estilos de la interfaz |
| INEGI BD externa | Validación geográfica de estado/municipio |
## 📂 Funcionalidades Principales
- Dashboard con métricas visuales.
- Formularios dinámicos de registro.
- Control y gestión de candidatos.
- Gestión de usuarios administradores.
- Interfaz para consulta y exportación de datos vía API.
## Documentación de API
En el siguiente enlace se encuentra el archivo .yaml de la documentación de la API que puede ser visualizado con Swagger Editor:
https://uvmx-my.sharepoint.com/:u:/g/personal/zs22016079_estudiantes_uv_mx/EU0hmEyOj29LgbF9R8CStdcBVLkB11Ik2SfwYQg9fWKXtw?e=Kz3nci