Librería Commons para proyectos GAPSI

Librería con funciones comunes, localStorage/sessionStorage con encriptado, RestClient fetch para consumo de API's

Tecnologías utilizadas 🛠️

Front End

• Node
• CryptoJs
• rxjs
• Javascript

Instrucciones

Estas instrucciones te permitirán obtener una copia del proyecto en funcionamiento en tu máquina local para propósitos de desarrollo y pruebas.

Requisitos 📋

Que cosas necesitas para instalar.

Front End

• Node.js
• Git

IDE's Recomendados

• Visual Studio Code

Instalación 🔧

Front End El proyecto como tal no es ejecutable, sin embargo en el apartado Ambientes se brinda una serie de instrucciones para poder ejecutar las funciones contenidas en éste proyecto

Ambientes

Debemos estar posicionados en la carpeta vas-mf-commons como raíz

Actualmente las funciones comunes se añadirán en Util.js, clase con funciones Útiles

Se contiene un archivo de testing, common.test.js en el cual las funciones que puedan probarse en consola, lo podemos testear desde aquí sin compilar

La forma de compilar es mediante node, ejecutando el archivo common.test.js con parámetros

node commons.test.js date 2023-12-12 DD/MM/YYYY

Donde, node es el comando principal, commons.test.js el archivo a ejecutar, date es el case de ejecución, y por último se plantean los parámetros que necesite para testing

Ejecutando la librería

Para poder hacer uso de esta librería, basta con agregar en package.json en el apartado dependencies la versión de la misma ejemplo:

"@vas-mkt-scope/vas-mf-commons": "1.0.9"

Versionado

La librería debe estar en constante actualización para agregar/mejorar las funciones comunes por lo que en su package.json se irá incrementando la versión con un consecutivo o haciendo uso de Semantic Version 2.0.0 / X.Y.Z en el cual Z para bugfixes o actualizaciones muy simples, Y updates menores, X updates mayores:

"version": "1.0.9"

Después de aumentar la versión se debe publicar con el siguiente comando (incluido en package.json)

npx google-artifactregistry-auth && npm publish

Version Estable Al momento de haber realizado éste README.md la versión estable es -> 1.0.9

Autores ✒️

Grupo de Asesores Profesionales en Servicios de Integración (GAPSI) - CDMX - 2023

Tech Lead

• Mauricio Rivera Velázquez

Front End

• Juan López Sarrelangue

Copyright (c) 2023 - Liverpool. All rights reserved