Skip to content

open-source-uc/v2-ramos

Repository files navigation

📚 Proyecto BuscaRamos

Este es un proyecto de estudiantes de la Pontificia Universidad Católica de Chile (UC) que busca revolucionar la forma en la que interactúa la comunidad estudiantil al momento de inscribir cursos.

🚀 Pasos para empezar

Para levantar el proyecto en tu máquina local, sigue estos pasos:

1. Instalar Dependencias

Primero, instala todas las dependencias del proyecto.

npm install

2. Configurar Variables de Entorno

Crea un archivo .env.local en la raíz del proyecto. Este archivo es crucial para que la aplicación funcione correctamente.

Puedes usar el archivo de ejemplo .env.local.example incluido en el repositorio. Para ello, ejecuta:

cp .env.local.example .env.local

Luego, edita el archivo .env.local y reemplaza los valores de ejemplo por los que correspondan según tu entorno.

# Indica el entorno a usar. Puede ser 'development' o 'production'
MODE_ENV="development"

# El secret de la API. Puedes usar un generador de contraseñas seguras para crear este valor.
API_SECRET="tu_secreto_aqui"

# ¡IMPORTANTE! Este token es SOLO para desarrollo.
# Puedes obtener un token en el panel de Auth Osuc (https://auth.osuc.dev/home/sessions).
USER_TOKEN="tu_token_de_usuario_aqui"

Notas:

  • API_SECRET: Usa un valor único y seguro.
  • USER_TOKEN: Simula un usuario autenticado en el entorno de desarrollo. Asegúrate de no exponerlo.

3. Ejecutar las Migraciones

El siguiente paso es poblar tu base de datos local. El script setup.sh se encargará de todo.

Desde la raíz del proyecto, ejecuta:

cd migration
bash setup.sh
cd ..

Cuando el script te pregunte, selecciona la opción 1) Local.

4. Iniciar el Servidor de Desarrollo

¡Ya casi estás! Ahora, inicia el servidor de desarrollo de Astro.

npm run dev

La aplicación estará disponible en http://localhost:4321.

🧞 Comandos Disponibles

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

Comando Acción
npm install Instala las dependencias.
npm run dev Inicia el servidor de desarrollo en localhost:4321.
npm run build Compila el sitio para producción en la carpeta ./dist/.
npm run preview Previsualiza tu compilación de producción localmente.

👀 ¿Quieres saber más?

Revisa la documentación de Astro.

About

Este es el repositorio oficial de BuscaRamos desarrollado por OpenSource eUC.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Contributors 10