📦 BYHOURS Libs

BYHOURS Libs es el paquete central de dependencias que permite el correcto funcionamiento del proyecto principal byhours y de los microsites que lo extienden.

[!NOTE] Este repositorio contiene todas las librerías compartidas y configuraciones esenciales que deben ser utilizadas por byhours y sus whitelabels (microsites).

⚡ Arquitectura del Proyecto

El ecosistema de BYHOURS está compuesto por los siguientes componentes principales:

1. byhours: Proyecto principal de la plataforma.
2. Microsites (Whitelabels): Implementaciones personalizadas basadas en BYHOURS, utilizando Nuxt Layers.
3. byhours-libs (este repositorio): Contiene todas las dependencias compartidas entre los proyectos anteriores. Está publicado en NPM para su fácil integración.

La relación entre estos proyectos es la siguiente:

 ┣ 📂 byhours-libs                # Paquete npm
 ┣ 📂 byhours                     # Proyecto principal
 ┣ 📂 [nombre-whitelabel]         # Whitelabel
 ┣ 📂 [nombre-otro-whitelabel]    # Otro Whitelabel

[!IMPORTANT] Todos los proyectos dependen de byhours-libs, lo que significa que cualquier actualización en sus dependencias debe propagarse correctamente a los demás.

✅ Instalación y Uso

Para utilizar byhours-libs en cualquier proyecto (BYHOURS o microsites), simplemente instálalo desde npm:

npm install byhours-libs

Esto asegurará que siempre tengas acceso a la última versión publicada de las dependencias comunes.

🌐 Publicación de byhours-libs en NPM

Cuando se realicen cambios en las dependencias de byhours-libs, es necesario publicarlos en npm para que los demás proyectos puedan recibir la actualización.

Pasos para publicar una nueva versión:

1. Asegúrate de estar autenticado en NPM:

   npm login

   [!TIP] Debes contar con un usuario con los permisos adecuados para publicar paquetes.

2. Publica la nueva versión en NPM:

   npm publish

🚀 Actualización de byhours-libs en los proyectos

Después de publicar una nueva versión de byhours-libs, los proyectos que dependen de él deben actualizarse manualmente para reflejar los últimos cambios.

Para actualizar byhours o cualquier microsite a la última versión de byhours-libs, ejecuta:

npm install byhours-libs@latest

Si deseas asegurarte de que siempre se use la última versión disponible, puedes modificar el archivo package.json en tu proyecto y permitir versiones más recientes usando ^ o ~ en la versión del paquete:

"dependencies": {
  "byhours-libs": "^x.y.z"
}

Luego ejecuta:

npm update byhours-libs

🛠️ Consideraciones Importantes

[!IMPORTANT] No modificar las dependencias de byhours-libs directamente en los proyectos. Cualquier cambio debe realizarse en byhours-libs y publicarse en npm.

[!IMPORTANT] Usar versiones bien definidas para evitar inconsistencias en los entornos de desarrollo y producción.

[!IMPORTANT] Revisar el changelog después de cada actualización para identificar posibles cambios que requieran ajustes en los proyectos dependientes.