README

📦 Descripción

Boilerplate Compac es un paquete para CodeIgniter 4 que proporciona una base sólida para integrar sistemas de nóminas con CONTPAQi Nóminas (Nomipac). Facilita la gestión de empleados, percepciones, deducciones, registros de incidencias y el envío de timbrados, todo mientras mantiene un registro detallado de cambios en cada módulo mediante un sistema de logging integrado.

Está pensado para acelerar el desarrollo de aplicaciones empresariales que requieran comunicación con el entorno fiscal mexicano y procesos de nómina complejos.

🚀 Requisitos

PHP >= 7.4 (o la versión soportada por CodeIgniter 4)
CodeIgniter 4.1.0 o superior
Composer
Base de datos MySQL/MariaDB (u otros motores soportados por CI4)

📥 Instalación

1. Instalar vía Composer

Ejecuta el siguiente comando:

composer require julio101290/boilerplatecompac

2. Ejecutar el instalador (migraciones y seeders)

El paquete incluye un comando que corre migraciones y datos iniciales automáticamente:

php spark boilerplatecompac:installcompac

Este comando:

Crea las tablas necesarias para empleados, nóminas, incidencias, logs, etc.
Inserta los datos de prueba (si existen) para comenzar rápidamente.

Nota: Asegúrate de haber configurado correctamente tu base de datos en el archivo .env antes de ejecutar este paso.

🧩 Integración con el Menú

Una vez instalado, el paquete agrega entradas al menú lateral de tu panel de administración (si usas el layout por defecto de CodeIgniter 4). Podrás acceder directamente a:

Dashboard de Nóminas
Gestión de Empleados
Percepciones y Deducciones
Incidencias
Timbrado CFDI
Bitácora de cambios (logs)

🖥️ Capturas de pantalla

A continuación, algunas vistas del módulo:

⚙️ Uso y Personalización

El paquete proporciona controladores, modelos, vistas y rutas listas para usar. Puedes extender o modificar cualquier componente según las necesidades de tu proyecto.

🔍 Estructura de rutas

Las rutas principales se registran automáticamente en app/Config/Routes.php a través del archivo de configuración del paquete. Para revisarlas, puedes inspeccionar el archivo vendor/julio101290/boilerplatecompac/src/Config/Routes.php.

📄 Logs de actividad

Todos los cambios (altas, bajas, modificaciones) en los módulos principales quedan registrados en la tabla bitacora. Puedes consultar el historial desde la interfaz o mediante consultas directas.

🧪 Datos de prueba

El seeder incluye datos de muestra para que puedas probar la funcionalidad sin tener que crear todo desde cero. Puedes desactivar los seeders modificando el comando de instalación o ejecutándolos por separado.

🔧 Configuración avanzada

Si necesitas ajustar parámetros como la conexión a Nomipac o los umbrales de log, publica el archivo de configuración con:

php spark boilerplatecompac:publish-config

Esto copiará boilerplatecompac.php a tu carpeta app/Config/, donde podrás editarlo libremente.

📚 Documentación Adicional

Para conocer más sobre la integración con CONTPAQi Nóminas, consulta la documentación oficial de Nomipac. Si encuentras algún error o quieres proponer mejoras, revisa la sección de Contribución.

📋 Registro de Cambios

Todos los cambios importantes en cada versión se documentan en el archivo CHANGELOG.md.

🤝 Cómo Contribuir

Las contribuciones son bienvenidas. Si deseas reportar un bug, solicitar una nueva funcionalidad o enviar un pull request, por favor:

Abre un issue describiendo el problema o mejora.
Si envías código, asegúrate de seguir el estándar de codificación de CodeIgniter 4 y de agregar pruebas cuando sea posible.

📄 Licencia

Este paquete es software libre y se distribuye bajo los términos de la Licencia MIT.

¡Feliz codificación! 🚀

julio101290 / boilerplatecompac

Maintainers

Package info

Statistics

Security