Saltearse al contenido

🚀 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.


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.

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

Para empezar a trabajar en el proyecto, sigue estos pasos:

Ventana de terminal
git clone https://github.com/jesulim/web-gdgsucre
cd web-gdgsucre

Usamos Bun para manejar las dependencias:

Ventana de terminal
bun install

Para correr la versión en desarrollo:

Ventana de terminal
bun dev

El sitio estará disponible en http://localhost:4321 🎉


Cada rama se despliega automáticamente en Vercel.

  • La rama principal main se 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.

Si deseas contribuir al proyecto:

  1. Crea una nueva rama siguiendo las convenciones.
  2. Confirma tus cambios y sube un Pull Request (PR).
  3. Espera la revisión y aprobación para hacer el merge a main.

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! 🚀