Internal Docs

Appearance

Metadata

Owner: core-team · Lifecycle: active · Last Reviewed: 2026-03-04 · Support: #core-team

References — DocForge ​

APIs y Documentación Interna ​

  • API de Generación de PDF — DocForge — Documentación completa de los endpoints REST para generar y descargar documentos PDF, incluyendo campos por template, errores y comportamiento del campo amount
  • Lineamientos de Templates — Sistema de diseño visual para crear nuevos templates PdfKit: paleta de colores, tipografía, estructura, reglas de paginación y convenciones de ID

Repositorios ​

  • doc-forge — Repositorio principal del microservicio DocForge con el código fuente completo, templates PdfKit, configuración de deploy con Docker y CapRover

Herramientas ​

  • CapRover — Plataforma PaaS open-source utilizada para el deploy automatizado. Permite despliegues con push al repositorio. Configurado vía captain-definition en la raíz del proyecto
  • PdfKit — Librería de generación de documentos PDF en Node.js utilizada como motor principal de renderizado. Permite crear PDFs programáticamente con control granular sobre texto, imágenes, fuentes y layout

Documentación Externa ​

  • NestJS Documentation — Framework base del microservicio (v9). Referencia para módulos, controladores, servicios, pipes de validación, inyección de dependencias y ServeStaticModule
  • PdfKit API Reference — Guía de la API de PdfKit incluyendo manejo de texto, imágenes, fuentes, paginación y bufferPages
  • CryptoJS Documentation — Librería de cifrado usada para enlaces temporales de descarga. DocForge usa AES para cifrar rutas de archivos y Base64 para la codificación del resultado
  • class-validator — Librería de validación basada en decoradores para validar los payloads de entrada. Define reglas en la clase createDocumentDTO
  • Docker Multi-stage Builds — Estrategia de build usada en el Dockerfile para separar compilación (stage builder) de ejecución (stage production) y optimizar el tamaño de la imagen
  • @nestjs/config — Módulo de configuración que carga variables de entorno desde .env al arrancar la aplicación
  • @nestjs/serve-static — Módulo para servir archivos estáticos desde public/ (imágenes de header, footer, firma, tabla de cuentas)