Sky Krono API NestJS
Es el API REST para la WebAPP/PWA SkyKrono integrado con Web Authentication para el inicio de sesion passworless
## :ledger: Index
- [Pre-Requisitos](#pre-requisitos-)
- [Instalación](#instalación-)
- [Base de Datos](#base-de-datos)
- [Scripts SQL](#Scripts-SQL)
- [Environment](#Environment)
- [Desarrollo](#desarrollo-%EF%B8%8F)
- [Unit-Test](#unit-test)
- [E2E-Test](#E2E-test)
- [Build](#build)
- [Despligue](#despliegue-)
- [Monitoreo](#monitoreo)
- [Analisis de Codigo](#analisis-de-codigo-)
- [Integración Continua](#integración-continua)
- [Logger](#logger)
- [Documentación](#documentacion)
- [Construido](#construido-con-)
## Comenzando 🚀
_Estas instrucciones te permitirán obtener una copia del proyecto en funcionamiento en tu máquina local para propósitos de desarrollo y pruebas._
## Pre-Requisitos 📋
_Software requerido_
```
NodeJS >= 14.X
NPM >= 8.X
NestJS >= 9.X
MySQL >=8.X
```
_Software opcional_
```
Visual Studio Code ( O el editor de su preferencia)
```
## Instalación 🔧
_Para ejecutar un entorno de desarrollo_
_Previamente ejecutar el comando en la terminal para descargar "node_modules" para el funcionamiento del proyecto_
```
npm install
```
_Previamente a ejecutar el servidor en desarrollo configurar el archivo .env con las credenciales del servidor correos y base de datos , ejecutar :_
```
npm run start:dev
```
_Dirigirse a la ruta http://localhost:3000/ donde tendra el API REST levantada_
### Base de Datos
_El diagrama de base de datos se construyo para el proyecto se describe en la imagen_
### Scripts SQL
_Se tiene el archivo `script.sql` en la raiz del proyecto , el cual contiene los scripts de creacion de Store Procedure y Events/Jobs en MySQL_
_Se requiere ejecutar para el correcto funcionamiento de las tareas programadas como registro de licencias , dias libres de los trabajadores_
### Environment
_Se tiene el archivo `env.template` , el cual posee un ejemplo de cada valor de las valores de entorno para poder desplegarlas en nuestro propio ambiente local o cloud_
## Desarrollo ⚙️
_Las siguientes instrucciones serviran para ejecutar en su entorno local la pruebas unitarias realizadas para el proyecto_
### Unit-Test
_Para ejecutar todos los Unit Test desarrollados en Jest y reporte de cobertura de codigo ejecutar el comando_
```
npm run test:cov
```
_La carpeta con la cobertura del codigo se creara en la raiz del proyecto con la siguiente ruta coverage/Icov-report/index.html el cual se puede visualizar_
### E2E-Test
_Los test fueron desarrollados en Jest con ayuda de SuperTest realizados a la API , para validar el funcionamiento adecuado en un entorno más real_
_Previamente configurar los datos de pruebas en el archivo `e2e-config.spec.ts` de la carpeta `e2e`_
_Para ejecutar todos los E2E Test y reporte de cobertura de codigo ejecutar el comando_
```
npm run test:e2e:cov
```
### Build
_Para generar el build de producción del proyecto ejecutar el siguiente comando:_
```
npm run build
```
## Despliegue 👨🏻💻
_Para desplegar el proyecto mediante Docker tiene el archivo `docker-compose.prod.yaml` y la carpeta `docker`_
_Las cuales contienes los `Dockerfile` y dependencias necesarias para levantar el proyecto_
_Se dockerizo sobre un servidor de proxy inverso nginx el cual se expone en el puerto **80** por default_
_Para construir la imagen y ejecutarla tenemos el siguiente comando , el cual tambien tomara nuestras variable de entorno del archivo `env`_
_Ejecutar el siguiente comando en la raiz del proyecto_
```
docker compose -f docker-compose.prod.yaml --env-file .env up -d --build skykronoapi nginx
```
_En caso de requerir volver a ejecutar el contenedor del proyecto previamente creado ejecutar el mismo comando_
## Monitoreo
_Adicionalmente en Docker se adiciono Prometheus y Grafana para el monitorio de nuestra API_
_Se configuro por default el puerto **9090** para Prometheus y para Grafana se configuro el puerto **2525**_
_DashBoard para monitoreo del API en Grafana_
_Se agrego tambien LogStash , ElasticSearch con Kibana para la ingesta y monitoreo de LOGs_
_Se configuro por default el puerto **5061** por default para Kibana_
_Para implementar el ELK se tomo el repositorio de Deaviantony Docker ELK_
_Se construyo un DashBoard para monitoreo de LOGs con sus status y metricas_
_Para ejecutar los contenedores referentes al monitoreo ejecutar el comando_
```
docker compose -f "docker-compose.prod.yaml" up -d --build elasticsearch prometheus grafana kibana logstash setup
```
_Previamente inicializar el API en su contenedor indicado en el apartado de despliegue con la siguiente configuración en .env_
```
LOGSTASH_ENABLED= true
LOGSTASH_PORT= 50000
LOGSTASH_NODE_NAME= SKY_KRONO_LOG
LOGSTASH_HOST= host.docker.internal
GRAFANA_PASSWORD='changeme'
KIBANA_SYSTEM_PASSWORD= changeme
LOGSTASH_INTERNAL_PASSWORD= changeme
ELASTIC_PASSWORD= changeme
```
_Si desea importar los dashboardS construidos para este proyecto se encuentran en la carpeta ```dashboard``` siendo los archivos:_
- ***grafana-sky-krono.json*** para **Grafana**
- ***kibana-sky-krono.ndjson*** para **Kibana**
## Analisis de Codigo 🔩
_**Pre requisitos**_
_En la raiz del proyecto se tiene el archivo *sonar-project.properties* el cual tiene las propiedades necesarias para ejecutarlo sobre un SonarQube_
_Configurar los apartados : *sonar.host.url* , *sonar.login* *sonar.password* con los datos de su instancia correspondiente o usar SonarCloud con su token correspondiente_
```
Sonaqube >= 9.X
```
_Las pruebas fueron realizas sobre *SonarQube 9.7* y *SonarCloud* para ejecutar el analisis de codigo ejecutar el comando para la instancia local:_
```
npm run sonar
```
_Reporte de Cobertura en SonarCloud_
## Integración Continua
_Se realizo un CI con SonarCloud para ejecuta de manera automatica los test_
_Se creo la carpeta `.github/workflows` con el archivo `build.yml` que contiene los pasos para desplegar mediante GitHub Actions nuestro CI_
_Posteriormente a la ejecución del workflow se generan los artifacts `reports-e2e-test` , `reports-unit-test` que contienen el reporte cobertura generado_
## Documentacion
_Se realizo la documentación del API Rest usando Swagger el cual puede encontrar en la ruta http://localhost:3000/docs/ en la configuración por default_
## Logger
_Se integro winston para reemplazar el logger de NestJS para realizar seguimiento y conservacion de los logs segun sea requerido_
_En el archivo `.env` se tienen los siguientes apartados configurados por default:_
```
APP_NAME=SKY_KRONO
DATE_PATTERN=YYYY-MM-DD
MAX_SIZE=20m
MAX_DAYS=14d
```
_Por default la carpeta donde se guardan los logs es `LOG` , el formato configurado es JSON_
## Construido con 🛠️
_Las herramientas utilizadas son:_
- [NestJS](https://nestjs.com/) - El framework para construir aplicaciones del lado del servidor eficientes, confiables y escalables.
- [NPM](https://www.npmjs.com/) - Manejador de dependencias
- [Jest](https://jestjs.io/) - Framework Testing para pruebas unitarias
- [Docker](https://www.docker.com/) - Para el despliegue de aplicaciones basado en contenedores
- [Nginx](https://www.nginx.com/) - Servidor de Proxy Inverso ligero
- [Graphana](https://grafana.com/) - Para la creación de DashBoard interactivos
- [Prometheus](https://prometheus.io/) -Aplicación para monitorear metricas en tiempo real
- [SonarQube](https://www.sonarqube.org/) - Evaluacion de codigo on premise
- [SonarCloud](https://sonarcloud.io/) - Evaluacion de codigo cloud
- [Visual Studio Code](https://code.visualstudio.com/) - Editor de Codigo
- [Prettier](https://prettier.io/) - Formateador de Codigo
- [WebAuthn](https://webauthn.guide/) - Estándar web del proyecto FIDO2 de la Alianza FIDO
- [TabNine](https://www.tabnine.com/) - Autocompletador de Codigo
- [Swagger](https://swagger.io/) - Automatización de Documentación
- [Winston](https://github.com/winstonjs/winston) - Logger para NodeJS
## Versionado 📌
Usamos [GIT](https://git-scm.com/) para el versionado.
## Autor ✒️
- **Jaime Burgos Tejada** - _Developer_
- [SkyZeroZx](https://github.com/SkyZeroZx)
- email : jaimeburgostejada@gmail.com