Librerías backend

💡En Inlaze se utilizan varias librerías para centralizar todos los códigos, tener utilidades, integraciones comunes como AWS, entre otras.

Resumen

Esta receta proporciona instrucciones detalladas sobre cómo instalar y utilizar varias librerías backend desarrolladas por Inlaze. Estas librerías están diseñadas para centralizar códigos comunes, utilidades, y facilitar integraciones, como con AWS y MongoDB. Al seguir esta guía, podrás integrar estas librerías en tus proyectos de manera eficiente.

Descripción

Inlaze utiliza varias librerías backend para estandarizar y centralizar funcionalidades comunes en sus aplicaciones. Estas librerías incluyen utilidades, interceptores, adaptadores, servicios de AWS, esquemas de MongoDB, y entidades de TypeORM. A continuación, se describen las librerías disponibles y cómo instalarlas en tus proyectos.

Prerrequisitos

• Node.js instalado

• pnpm instalado

• Token de npm guardado en el sistema operativo o en la parte local donde se va a instalar

• Conocimientos básicos de integración de librerías en proyectos Node.js

Casos de Uso

• Centralizar utilidades y códigos comunes en proyectos backend.

• Integrar servicios de AWS, como S3, en aplicaciones de manera eficiente.

• Utilizar esquemas y entidades de MongoDB en proyectos relacionados con Affiliates de Inlaze.

• Gestionar entidades y repositorios de TypeORM en proyectos de Affiliates de Inlaze.

Instrucciones Paso a Paso

1. Instalar la Librería Common

El import path es @inlaze_techlead/inlaze-common.

pnpm i -E @inlaze_techlead/inlaze-common

Esta librería incluye utilidades, interceptores, adaptadores, y otros recursos que pueden ser utilizados en cualquier aplicación de Inlaze, independientemente del core de negocio.

2. Instalar la Librería Aws

El import path es @inlaze_techlead/inlaze-aws.

pnpm i -E @inlaze_techlead/inlaze-aws

Esta librería proporciona un servicio de S3 actualmente para AWS, y puede extenderse según las necesidades para integrar más funcionalidades de AWS en las aplicaciones.

3. Instalar la Librería Mongo

El import path es @inlaze_techlead/inlaze-mongo.

pnpm i -E @inlaze_techlead/inlaze-mongo

Esta librería contiene esquemas y entidades de MongoDB para utilizar en los proyectos relacionados con Affiliates de Inlaze.

4. Instalar la Librería Typeorm

El import path es @inlaze_techlead/inlaze-typeorm.

pnpm i -E @inlaze_techlead/inlaze-typeorm

Esta librería incluye entidades y repositorios de TypeORM para usar en los proyectos relacionados con Affiliates de Inlaze.

Validación

1. Verifica que las librerías se hayan instalado correctamente ejecutando pnpm list y comprobando que aparecen en la lista de dependencias.

2. Importa y utiliza las librerías en tu código para asegurarte de que funcionan como se espera:

   import { someUtility } from '@inlaze_techlead/inlaze-common';
   import { S3Service } from '@inlaze_techlead/inlaze-aws';
   import { someSchema } from '@inlaze_techlead/inlaze-mongo';
   import { someEntity } from '@inlaze_techlead/inlaze-typeorm';

Solución de Problemas

• Error de autenticación de npm: Asegúrate de que el token de npm esté correctamente configurado en tu sistema operativo o en la configuración local.

• Problemas de instalación: Verifica la versión de pnpm y asegúrate de que estás usando la última versión compatible.

• Errores al importar: Asegúrate de que las rutas de importación sean correctas y que las librerías estén correctamente instaladas en el directorio node_modules.

Preguntas Frecuentes

• ¿Puedo usar npm o yarn en lugar de pnpm?

  • Sí, puedes utilizar npm o yarn, pero en esta receta usamos pnpm por los estándares de la empresa.|

• ¿Cómo puedo extender las funcionalidades de las librerías?

  • Puedes clonar el repositorio de la librería, agregar las funcionalidades necesarias, y luego publicar la nueva versión en el registro correspondiente.

Recursos Adicionales

• Documentación Oficial de Nx

• Documentación de pnpm

• Guía de Monorepositorios con Nx

Conclusión

Al seguir esta receta, has aprendido cómo instalar y utilizar varias librerías backend de Inlaze, que te ayudarán a centralizar códigos comunes, utilidades, y facilitar integraciones en tus proyectos. Estas librerías están diseñadas para mejorar la eficiencia y mantener las mejores prácticas de programación en todas las aplicaciones de Inlaze.