Backend Base - NestJS

Recomendaciones

Para usar este proyecto como base de un nuevo proyecto, debe seguir los siguientes pasos:

• Crear nuevo proyecto en Gitlab y clonarlo en local
• Añadir este proyecto como otro origen, ejecutar dentro del nuevo proyecto:

git remote add origin2 [email protected]:agetic/agetic/proyectos-base/agetic-nestjs-base-backend.git

• Descargar los commits desde el 2.º origen, ejecutar

git pull origin2 master --allow-unrelated-histories

Tecnologías

| Nombre | Descripción | Sitio Web | | ----------- | ----------------------------------------------------------------- | -------------------------- | | NestJS | Framework de Node.js con TypeScript para aplicaciones escalables. | https://nestjs.com | | Jest | Framework de prueba de JavaScript de fácil uso. | https://jestjs.io | | Passport.js | Middleware de autenticación para Node.js. | http://www.passportjs.org | | OpenAPI | Estándar de descripción de API para documentación. | https://www.openapis.org | | TypeORM | ORM para TypeScript y JavaScript para bases de datos. | https://typeorm.io | | PinoJs | Registro eficiente para aplicaciones Node.js. | https://getpino.io | | Casbin | Biblioteca de control de acceso flexible. | https://casbin.org | | PostgreSQL | Sistema de gestión de bases de datos relacional. | https://www.postgresql.org | | Docker | Plataforma de contenedorización para empaquetar aplicaciones. | https://www.docker.com |

Funcionalidades

• Autenticación JWT
• Autenticación con Ciudadanía Digital
• Refresh Token
• Autorización (Roles, Módulos, Usuarios, Permisos)
• Paramétricas
• Clientes para Interoperabilidad (SEGIP, SIN)
• Cliente para Mensajería Electrónica
• Proveedores de:
  • Logger
  • Reportes
  • Manejo de errores

Documentación

Documentación relacionada con el proyecto:

1. Instalación y Configuración
2. Arquitectura
3. Documentación de APIS
4. Documentación de Permisos

Comandos útiles

1. Crea la base de datos desde cero (con docker)

   $ npm run db:create

2. Generación del diagrama ERD (deshabilitado hasta tener soporte para TypeOrm 0.3)

   $ npm run db:diagram

3. Generación de documentación

   $ npm run compodoc

Changelog

1. Generar tag y archivo CHANGELOG. patch (0.0.x) | minor (0.x.0) | major (x.0.0)

   $ npm run release -- --release-as patch

2. Guardar los tags generados

   $ git push --follow-tags origin master

Colaboradores

• [email protected]
• [email protected]
• [email protected]
• [email protected]
• [email protected]

Licencia

LGP-Bolivia.

Información de contacto

• [email protected]