Servieduca-lib-common-entity NPM

servieduca-lib-common-entity

Libreria orientada a la funcionalidad core y cross para los distintos microservicios

Comenzando 🚀

Descargar Fuentes de git

git clone git@gitlab.com:plataforma-bs2/software/plataforma-base/backends/servieduca-lib-common-entity.git
git checkout develop

Una vez descargada las fuentes de debe ejecutar en consola:

npm install

Para publicar la libreria en el repositorio respectivo se necesita subir la version y ejecutar los comandos:
npm run build
npm publish

Agrupación

La estructura del proyecto es la siguiente

src
-- core
-- api-schemas
-- constants
-- decorators
-- dto
-- filters
-- guards
-- interceptors
test

Pre-requisitos 🛠

NodeJs
Nest CLI
Variables de entorno instaladas en el ambiente donde se montara
Docker
IDE (Preferentemente Visual Studio Code)
GIT

Instalación 🔧

1.- La instalacion principal estara dada por la publicacion de esta libreria

2.- En cada componente donde se desea utilizar esta libreria deberia hacer referenfia en el archivo package.json de la siguiente manera en las dependencies

"servieduca-lib-common-entity": "^0.0.8"

3.- ejecutar el comando npm install para instalacion o actualizacion de la libreria en los componentes que la referencien

Despliegue 📦

Despliegue en IC: solo se debe solicitar un merge request a develop.
Despliegue en TEST, PREPROD, PRODUCCION: el pipeline se encargara de publicar la libreria en los respectivos nexus cuando se ejecute el stage correspondiente

Construido con 🛠

Herramientas y lenguajes utilizados

Javascript - Lenguaje de programacion.
Nodejs - Entorno de tiempo de ejecución de JavaScript.
NestJs - Framework basado en node.js para construir aplicaciones de lado servidor.
Visual Studio Code - IDE de desarrollo.
DBeaver - Herramienta de base de datos.
Swagger - Documentacion de los servicios.