# {Nombre del Modulo} **Version:** X.Y.Z **Estado:** production | beta | deprecated **Ultima actualizacion:** YYYY-MM-DD **Categoria:** {categoria} --- ## Descripcion {Descripcion clara del proposito del modulo en 2-3 oraciones} ## Caracteristicas - Caracteristica 1 - Caracteristica 2 - Caracteristica 3 - ... ## Compatibilidad | Tecnologia | Version Minima | |------------|----------------| | Node.js | 18+ | | NestJS | 9.0+ | | TypeScript | 5.0+ | | PostgreSQL | 14+ | ## Instalacion Rapida ```bash # 1. Copiar modulo cp -r path/to/module your-project/src/modules/{module-name} # 2. Instalar dependencias npm install {dependencies} # 3. Configurar variables de entorno # Ver .env.example en este modulo ``` ## Configuracion ### Variables de Entorno ```env # Requeridas {MODULE}_ENABLED=true {MODULE}_CONFIG_1=value # Opcionales {MODULE}_OPTIONAL_CONFIG=value ``` ### Integracion en NestJS ```typescript // app.module.ts import { {Module}Module } from './modules/{module-name}/{module}.module'; @Module({ imports: [ {Module}Module.forRoot({ // configuracion }), ], }) export class AppModule {} ``` ## API / Interfaces Ver: [API.md](./API.md) ## Ejemplos Ver directorio: [examples/](./examples/) - `examples/basic/` - Implementacion basica - `examples/advanced/` - Implementacion avanzada - `examples/with-customization/` - Con personalizaciones ## Proyectos que lo Usan - [proyecto1](../../trazabilidad/proyecto1.md) - [proyecto2](../../trazabilidad/proyecto2.md) ## Modulos Relacionados - [modulo-relacionado-1](../categoria/modulo-1/) - Descripcion - [modulo-relacionado-2](../categoria/modulo-2/) - Descripcion ## Changelog Ver: [CHANGELOG.md](./CHANGELOG.md) ## Propagacion Cuando este modulo se actualiza, los siguientes proyectos deben evaluarse: | Proyecto | Version Actual | Accion | |----------|----------------|--------| | proyecto1 | X.Y.Z | Evaluar upgrade | | proyecto2 | X.Y.Z | Evaluar upgrade | ## Contribuir 1. Fork del repositorio 2. Crear branch: `feature/{descripcion}` 3. Hacer cambios 4. Crear PR con descripcion clara 5. Actualizar CHANGELOG.md --- **Mantenedor:** @Architecture-Analyst **Ubicacion:** modules/{categoria}/{modulo}/