🚀 Bienvenido a Web GDG Sucre
Este documento te guiará en el proceso de configuración, estructura del proyecto y mejores prácticas para contribuir a este repositorio.
📌 Tecnologías Utilizadas
Sección titulada «📌 Tecnologías Utilizadas»El proyecto está construido con las siguientes tecnologías:
- Bun - Gestor de paquetes rápido y eficiente.
- Astro - Framework ligero para sitios estáticos y optimizados.
- Tailwind CSS - Framework de CSS orientado a clases utilizarias.
- shadcn/ui - Biblioteca de componentes UI personalizables con Tailwind.
- Supabase - Backend como servicio para autenticación, base de datos y almacenamiento de archivos.
- Starlight - Framework de documentación escrito en Astro.
- Vercel - Plataforma de despliegue y hosting.
📁 Estructura del Proyecto
Sección titulada «📁 Estructura del Proyecto»El repositorio se encuentra en GitHub y está organizado de la siguiente manera:
Directorypublic/ Archivos estáticos públicos: favicon, etc.
- …
Directorysrc
Directoryassets/ Archivos estáticos de uso interno: Tipos de letra, imágenes
- …
Directorycomponents Componentes UI
Directoryevents Componentes UI específicos para cada evento
Directoryio-extended-25
- Hero.astro Componente específico de un evento
Directoryui/ Componentes generales de shadcn/ui
- …
- Header.astro Componente global
Directorylayout Estructura de las páginas
- BaseLayout.astro
Directorylib Código compartido por componentes, páginas y endpoints
Directoryservices/ Servicios para conectar a supabase
- …
Directorytemplates/ Plantillas de emails
- …
Directoryvalidators/ Schemas de zod para validación de datos
- …
Directorypages Páginas y Endpoints
Directoryapi Endpoints
- register.ts
Directoryregistro
- [eventSlug].astro Página de registro según el evento
- index.astro Página principal
Directorystyles
- global.css Estilos globales, fuente, colores, etc.
- .env Variables de entorno
- .gitignore
- README.md
🛠️ Configuración Inicial
Sección titulada «🛠️ Configuración Inicial»Para empezar a trabajar en el proyecto, sigue estos pasos:
1️⃣ Clona el Repositorio
Sección titulada «1️⃣ Clona el Repositorio»git clone https://github.com/jesulim/web-gdgsucrecd web-gdgsucre2️⃣ Instala las Dependencias
Sección titulada «2️⃣ Instala las Dependencias»Usamos Bun para manejar las dependencias:
bun install3️⃣ Ejecuta el Proyecto en Local
Sección titulada «3️⃣ Ejecuta el Proyecto en Local»Para correr la versión en desarrollo:
bun devEl sitio estará disponible en http://localhost:4321 🎉
🚀 Despliegue
Sección titulada «🚀 Despliegue»Cada rama se despliega automáticamente en Vercel.
- La rama principal
mainse despliega directamente a www.gdgsucre.com - Las demás ramas, se despliegan a un subdominio de Vercel. Cuando subas tu Pull Request a GitHub, tendrás un comentario del bot vercel con el link al subdominio temporal.
📢 Cómo contribuir
Sección titulada «📢 Cómo contribuir»Si deseas contribuir al proyecto:
- Crea una nueva rama siguiendo las convenciones.
- Confirma tus cambios y sube un Pull Request (PR).
- Espera la revisión y aprobación para hacer el merge a
main.
❓ Preguntas Frecuentes
Sección titulada «❓ Preguntas Frecuentes»No sé mucho sobre Astro, ¿puedo contribuir?
Sí, el proyecto busca que cualquier persona pueda aprender y aportar. Puedes empezar con documentación, corrección de errores o mejora del código existente.
¿Cómo puedo sugerir una nueva funcionalidad?
Contacta al equipo o crea un issue en GitHub explicando tu idea.
🎉 ¡Gracias por tu interés en contribuir en la Web del GDG Sucre! 🚀