alexbvart / abv-ui

ui library

ABV Component Library

Descripción

Este proyecto es una biblioteca de componentes de React desarrollada utilizando las mejores prácticas y herramientas modernas. Incluye componentes estilizados con styled-components, soporta Storybook para la visualización de componentes, y está configurada para fácil despliegue en Netlify.

Sitios en Producción

• Aplicación: Visitar la aplicación
• Storybook: Visitar Storybook

---

Requisitos Previos

Asegúrate de tener instalados los siguientes requisitos en tu entorno de desarrollo:

• Node.js (versión 16 o superior recomendada)
• npm o Yarn

---

Instalación

Sigue los pasos a continuación para instalar las dependencias del proyecto:

1. Clona el repositorio:

   git clone https://github.com/tu-usuario/abv-component.git

2. Navega al directorio del proyecto:

   cd abv-component

3. Instala las dependencias usando npm o Yarn:

   npm install

   o

   yarn install

---

Scripts Disponibles

Levantar el Proyecto en Local

Para levantar la aplicación en un entorno de desarrollo local:

npm run dev

o

yarn dev

Esto iniciará un servidor de desarrollo utilizando Vite, y la aplicación estará disponible en http://localhost:3000.

Levantar Storybook en Local

Para iniciar Storybook y ver los componentes de la biblioteca:

npm run storybook

o

yarn storybook

Esto abrirá Storybook en http://localhost:6006, donde podrás navegar y ver los diferentes componentes.

---

Herramientas y Tecnologías

El proyecto utiliza las siguientes tecnologías y herramientas:

• React: Biblioteca principal para la construcción de interfaces de usuario.
• TypeScript: Para tipado estático y mejoras de desarrollo.
• Styled-components: Para estilos CSS-in-JS.
• Storybook: Para el desarrollo y documentación de componentes.
• Vite: Como herramienta de construcción y servidor de desarrollo rápido.
• ESLint: Para el linting del código.
• Testing Library: Para pruebas de componentes de React.
• clsx: Para el manejo de clases condicionales.

---

Contribuir

Estamos encantados de recibir contribuciones. Por favor, sigue las siguientes pautas para contribuir:

1. Clona el Repositorio:

   git clone https://github.com/tu-usuario/abv-component.git

2. Crea una Nueva Rama para tu Funcionalidad o Corrección de Error:

   git checkout -b feature/nueva-funcionalidad

3. Haz tus Cambios y Realiza un Commit:

   git commit -m "Añadida nueva funcionalidad"

4. Envía tus Cambios a tu Repositorio:

   git push origin feature/nueva-funcionalidad

5. Abre un Pull Request en GitHub:

   • Describe claramente tus cambios y por qué deberían ser fusionados.

---

Soporte

Si encuentras algún problema o tienes preguntas, por favor abre un issue en GitHub.

---

Licencia

Este proyecto está licenciado bajo la Licencia MIT. Consulta el archivo LICENSE para más detalles.