@agendateapp/agendateapp-codes

Este proyecto contiene una lista centralizada de códigos y mensajes que son manejados por las diferentes aplicaciones de la plataforma AgendateApp.

Estructura del Proyecto

El archivo principal es index.js, donde se definen los códigos y mensajes que serán utilizados en todas las aplicaciones.

/**
 * Code enum for messages.
 * @module lang
 * @author VACR
 * @copyright (c) 2024 AgendateApp
 */

const messages = {
  E_001: { status: 401, id: 'E-001', message: 'Token is required' },
  // ... otros mensajes
};

module.exports = messages;

Publicación del Paquete

Para distribuir este paquete a los diferentes proyectos de AgendateApp, puedes usar npm pack para empaquetarlo y luego instalarlo en los proyectos que lo necesiten.

Paso 1: Empaquetar el Paquete o generar link

Navega a la carpeta del proyecto @agendateapp/agendateapp-codes y ejecuta:

npm pack
# ó
npm link

Este comando generará un archivo .tgz en la carpeta del proyecto, que es el archivo empaquetado que se puede instalar en otros proyectos.

Tres opciones de uso

Opción 1

Paso 2: Instalar el Paquete en Otros Proyectos

En cada proyecto que necesite utilizar los códigos y mensajes, sigue los siguientes pasos:

Copiar el archivo empaquetado: Copia el archivo .tgz generado en el paso anterior al directorio de tu proyecto local.

Instalar el paquete: Desde la raíz del proyecto, ejecuta:

npm install ./ruta/al/archivo/@agendateapp-agendateapp-codes-1.0.0.tgz

Esto instalará el paquete @agendateapp/agendateapp-codes como una dependencia local del proyecto.

Paso 3: Uso del Paquete en Proyecto

Una vez instalado, puedes importar y usar los códigos y mensajes en tu aplicación de la siguiente manera:

const messages = require('@agendateapp/agendateapp-codes');

console.log(messages.E_001.message); // "Token is required"

Opción 2

Paso 2: Copiar comprimido al proyecto donde se usará

# Pasar a proyecto de main siempre teniendo en cuenta la versión del comprimido "X"
cp agendateapp-agendateapp-codes-1.0.X.tgz ../agendateapp.main/

Paso 3: En el proyecto destino, volver a instalarlo

# Pasar a proyecto de main
cp agendateapp-agendateapp-codes-1.0.X.tgz ../agendateapp.main/

# En proyecto destino cambiar en el package.json el archivo y omitir el antiguo
npm i

Opción 3

Paso 2: En la carpeta destino ejecutar

npm link @agendateapp/agendateapp-codes

Paso 3: Para docker

# Usa en el dockerfile
COPY ../agendateapp-codes ./node_modules/@agendateapp/agendateapp-codes

Contribuir

Si necesitas agregar o modificar algún mensaje, realiza los cambios necesarios en el archivo index.js, y luego sigue el proceso de empaquetado e instalación en los demás proyectos.