📘 Libreria UI para Global66

Este repositorio utiliza herramientas modernas para la creación, documentación y publicación de componentes reutilizables en Vue.js. A continuación, encontrarás las instrucciones detalladas para cada sección clave.

🧩 Añadir Componentes

Librería utilizada: Lerna
Lerna facilita la gestión de monorepositorios, permitiéndote trabajar con múltiples paquetes en un mismo repositorio.

📕 Recurso recomendado:
Consulta este artículo en Medium para aprender cómo configurar y usar Lerna para compartir componentes Vue.js reutilizables.

📖 Añadir Stories

Librería utilizada: Storybook
Storybook permite crear una interfaz interactiva donde puedes visualizar y probar tus componentes en diferentes estados. Es ideal para documentar y demostrar cómo funcionan tus componentes.

🔗 Documentación oficial:
Consulta los docs de Storybook para aprender cómo escribir y gestionar tus historias.

⚙️ Requisitos Previos

• 🌐 NVM (Node Version Manager): Utiliza una versión de Node superior a la 20.
• 🛠️ Git: Para el control de versiones y la gestión del repositorio.
• 📦 Yarn: Administrador de paquetes opcional, recomendado para trabajar con este proyecto.
• 🔗 Corepack: Herramienta para habilitar Yarn o pnpm con versiones específicas.

🚀 Instalación y Uso del Proyecto

¡Sigue estos simples pasos para instalar y ejecutar el proyecto en tu máquina local! 🛠️

1. Clona este repositorio:

1 opción -> https://github.com/Flash-Global66/global-design-system.git
2 opción -> gh repo clone Flash-Global66/global-design-system
cd global-design-system/

2. Instala las dependencias:

I. Habilita yarn en tu versión de node actual.

corepack enable yarn

II. Usa la ultima versión de yarn.

corepack use yarn@latest

• ⚠️ Si ya se instalaron dependencias omite el paso III. ⚠️

III. Instala las dependencias del proyecto.

yarn install

3. Inicia el proyecto en modo de desarrollo:

yarn storybook

🚧 Posibles Errores de Instalación y Soluciones

Si encuentras problemas durante la instalación, no te preocupes, aquí tienes una lista de los errores más comunes y cómo solucionarlos:

🛑 Error 1: "Error de addon controls con storybook" (Error de instalación)

Este error ocurre porque se encuentran problemas con el yarn.lock

Solución:

La solución es borrar el archivo yarn.lock del proyecto y volver a correr los pasos de las sección de Instalación y Uso del Proyecto.

🚀 Contribuidores

Agradecemos enormemente el esfuerzo y dedicación de todas las personas que han contribuido a este proyecto. 💖 (emoji key):

Contributors 👨‍💻

Andersson Mesa 💻🎨🤔🧑‍🏫

Max 💻

erikfille 💻

Andres Carmona 💻

Joan Rojas 📖