Skip to content

open-source-uc/osuc.dev-v2

Repository files navigation

Open Source UC - Website

Sitio web oficial de Open Source UC, construido con Astro y Tailwind CSS.

Astro Tailwind CSS TypeScript License


🚀 Instalación rápida

Requisitos

  • Node.js 20+
  • pnpm 10+

Setup

  1. Clona el repositorio:
git clone <URL_DEL_REPO>
cd osuc.dev-v2
  1. Instala dependencias:
pnpm install
  1. Crea un archivo .env en la raíz:
GITHUB_TOKEN=tu_token_de_github
  1. Inicia el entorno de desarrollo:
pnpm dev

Disponible en: http://localhost:4321


🧞 Comandos

Todos los comandos se ejecutan desde la raíz del proyecto:

Comando Acción
pnpm install Instala dependencias
pnpm dev Inicia servidor local en localhost:4321
pnpm build Construye el sitio para producción en ./dist/
pnpm preview Previsualiza el build localmente

✨ Características

  • Integración con GitHub GraphQL API para repositorios destacados
  • Caché en desarrollo para evitar llamadas repetidas
  • Contenido en Markdown con estilos consistentes
  • Arquitectura modular con componentes Astro reutilizables
  • Preparado para despliegue continuo en Cloudflare Pages

🛠️ Stack

⚙️ Configuración

Variables de entorno

  • GITHUB_TOKEN: token de GitHub con permisos de lectura para repositorios públicos

Integración con GitHub

El sitio consume repositorios de open-source-uc y, en desarrollo, guarda caché por 30 minutos en .astro/cache/github-repos.json.

🧱 Estructura del proyecto

/
├── public/           # Archivos estáticos
├── src/
│   ├── components/   # UI reutilizable (incluye Icons y Layout)
│   ├── content/      # Markdown y configuración de colecciones
│   ├── data/         # Datos del sitio
│   ├── pages/        # Rutas del sitio
│   ├── styles/       # Estilos globales y temas
│   └── utils/        # Integraciones (ej: GitHub API)
├── astro.config.mjs
└── package.json

🚀 Despliegue

Este sitio está preparado para Cloudflare Pages.

Configuración recomendada:

  • Framework preset: Astro
  • Build command: pnpm build
  • Build output directory: dist
  • Variable de entorno: GITHUB_TOKEN

📄 Licencia

Este proyecto está bajo licencia MIT. Revisa LICENSE para más detalles.

About

Landing Page oficial de Open Source UC

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors