Awesome

Este toolkit está pensada para ser utilizado en NestJS Starter, o cualquier proyecto que utilice una configuración centralizada, siguiendo la misma arquitectura del starter.

Glosario

• 🥳 Demo
• 📝 Requerimientos básicos
• 💻 Scripts
• 🧰 Toolkit
• 📤 Commits
• 📜 License MIT

<a name="basic-requirements"></a>

📝 Requerimientos básicos

• NestJS Starter
• Node.js v20.18.0 or higher (Download)
• YARN v1.22.19 or higher
• NPM v10.9.0 or higher
• NestJS v10.4.7 or higher (Documentación)
• Lerna

<a name="scripts"></a>

💻 Scripts

Instalar Lerna

npm i -g lerna

Instalar dependencias del monorepo

yarn install

Crear paquetes

yarn plop

Transpilar paquetes

yarn build

Test paquetes

yarn test

<a name="toolkit"></a>

🧰 Toolkit

Los módulos de la siguiente lista, están pensados para ser consumidos por el NestJS Starter, siguiendo los lineamientos de schematics.

⚠️ Es recomendable utilizar las versiones stables, ya que las versiones beta están pensadas para ser utilizadas a modo de testing y pueden generar conflictos en el código.

Package	Descripción	Versión	Changelog
@tresdoce-nestjs-toolkit/archetype	Módulo informativo de la app		Changelog
@tresdoce-nestjs-toolkit/aws-sqs	Módulo de cola de mensajes de AWS Simple Queue Service		Changelog
@tresdoce-nestjs-toolkit/camunda	Módulo de procesos BPMN con Camunda		Changelog
@tresdoce-nestjs-toolkit/commons	Centralización de configuraciones		Changelog
@tresdoce-nestjs-toolkit/core	Funcionalidades a nivel core		Changelog
@tresdoce-nestjs-toolkit/dynamoose	Módulo de base de datos DynamoDB - Dynamoose		Changelog
@tresdoce-nestjs-toolkit/elk	Módulo de ElasticSearch Stack		Changelog
@tresdoce-nestjs-toolkit/filters	Librería para filtrar y formatear las excepciones		Changelog
@tresdoce-nestjs-toolkit/health	Módulo health checks liveness y readiness		Changelog
@tresdoce-nestjs-toolkit/http-client	Módulo http request con axios y axios-retry		Changelog
@tresdoce-nestjs-toolkit/mailer	Módulo para envíos de mail		Changelog
@tresdoce-nestjs-toolkit/paas	Librería centralizada de funcionalidades cross		Changelog
@tresdoce-nestjs-toolkit/qrcode	Módulo para crear códigos QR		Changelog
@tresdoce-nestjs-toolkit/rate-limit	Módulo para limitar los requests por segundo a los controllers		Changelog
@tresdoce-nestjs-toolkit/redis	Módulo de Redis para cache		Changelog
@tresdoce-nestjs-toolkit/response-parser	Interceptor de formateo de respuesta		Changelog
@tresdoce-nestjs-toolkit/snowflake-uid	Módulo de SnowFlake ID		Changelog
@tresdoce-nestjs-toolkit/test-utils	Utilities para testing		Changelog
@tresdoce-nestjs-toolkit/tracing	Módulo de traza con OpenTelemetry		Changelog
@tresdoce-nestjs-toolkit/typeorm	Módulo de ORM para base de datos		Changelog
@tresdoce-nestjs-toolkit/utils	Utilitarios para proyectos y librerías		Changelog

<a name="commits"></a>

📤 Commits

Para los mensajes de commits se toma como referencia conventional commits.

<type>[optional scope]: <description>

[optional body]

[optional footer]

• type: chore, docs, feat, fix, refactor, test (más comunes)
• scope: indica la página, componente, funcionalidad
• description: comienza en minúsculas y no debe superar los 72 caracteres.

Ejemplo Commit

git commit -m "docs(core): add documentantion to readme core module"

Commit Breaking Change

git commit -am 'feat!: changes in application'