Configuración del entorno de desarrollo

Esta guía lo guiará en la configuración de un entorno de desarrollo local para omegaUp usando Docker.

Requisitos previos

Antes de comenzar, asegúrese de tener instalado lo siguiente:

• Docker Engine: Instalar Docker
• Docker Compose 2: Instalar Docker Compose
• Git: Para clonar el repositorio

Configuración específica de Linux

Si está ejecutando Linux, después de instalar Docker, agregue su usuario al grupo de Docker:

sudo usermod -a -G docker $USER

Paso 1: bifurcar y clonar el repositorio

1. Bifurcar el repositorio: visita github.com/omegaup/omegaup y haz clic en el botón "Bifurcar"

2. Clona tu tenedor:

   git clone --recurse-submodules https://github.com/YOURUSERNAME/omegaup
   cd omegaup
   

3. Inicializar submódulos (si es necesario):

   git submodule update --init --recursive
   

Paso 2: Iniciar contenedores Docker

Configuración por primera vez

En su primera ejecución, extraiga las imágenes de Docker e inicie los contenedores:

docker-compose pull
docker-compose up --no-build

frontend_1     | Child frontend:
frontend_1     |        1550 modules
frontend_1     |     Child HtmlWebpackCompiler:
frontend_1     |            1 module
...

Ejecuciones posteriores

Después de la primera ejecución, puedes iniciar contenedores más rápido con:

docker compose up --no-build

Paso 3: acceda a su instancia local

Una vez que los contenedores se estén ejecutando, acceda a su instancia local de omegaUp en:

http://localhost:8001

Paso 4: Acceder a la consola del contenedor

Para ejecutar comandos dentro del contenedor:

docker exec -it omegaup-frontend-1 /bin/bash

Cuentas de Desarrollo

Su instalación local incluye cuentas preconfiguradas:

Cuenta de administrador

• Nombre de usuario: omegaup
• Contraseña: omegaup
• Rol: Administrador (privilegios de administrador de sistemas)

Cuenta de usuario habitual

• Nombre de usuario: user
• Contraseña: user
• Rol: Usuario habitual

Cuentas de prueba

Para fines de prueba, puede utilizar estas cuentas de prueba:

Ejecución de pruebas localmente

Si desea ejecutar pruebas de JavaScript/TypeScript fuera de Docker:

Requisitos previos

1. Node.js: Versión 16 o superior
2. Yarn: Administrador de paquetes

Pasos de configuración

1. Inicializar submódulos de Git:

   git submodule update --init --recursive
   

   Esta descarga requiere dependencias:
2. pagedown - Editor de rebajas
3. iso-3166-2.js - Códigos de país/región
4. csv.js - Análisis CSV

5. mathjax - Representación matemática

6. Instalar dependencias:

   yarn install
   

7. Ejecutar pruebas:

   yarn test
   

Inicio rápido (clon nuevo)

Para un clon nuevo, use este único comando:

git clone --recurse-submodules https://github.com/YOURUSERNAME/omegaup
cd omegaup
yarn install
yarn test

Estructura de la base de código

El código base de omegaUp está organizado de la siguiente manera:

omegaup/
├── frontend/
│   ├── server/
│   │   └── src/
│   │       ├── Controllers/    # Business logic & API endpoints
│   │       ├── DAO/            # Data Access Objects
│   │       └── libs/           # Libraries & utilities
│   ├── www/                    # Frontend assets (TypeScript, Vue.js)
│   ├── templates/              # Smarty templates & i18n files
│   ├── database/               # Database migrations
│   └── tests/                  # Test files

El flujo de contribución (ramas, PR, remotos) está en Contribuyendo.

Visual Studio Code con Docker

Puede editar desde el anfitrión con Visual Studio Code mientras Docker ejecuta el stack.

Extensiones recomendadas

• Dev Containers o Docker para adjuntarse a un contenedor en ejecución
• Extensiones PHP, Vue y ESLint según los archivos que modifique

Adjuntarse al contenedor frontend

1. Inicie el entorno: docker compose up --no-build (o docker compose up la primera vez).
2. En VS Code, use Attach to Running Container y elija el contenedor del frontend (a menudo omegaup-frontend-1; el nombre exacto aparece en docker compose ps).
3. En la ventana adjunta, abra la carpeta /opt/omegaup (el proyecto montado dentro del contenedor).

También puede editar el clon en el anfitrión: el mismo árbol se monta en /opt/omegaup y webpack dentro del contenedor recoge los cambios.

GitHub OAuth (inicio de sesión local con GitHub)

1. Crear la OAuth App en GitHub

1. Abra Configuración para desarrolladores de GitHub.
2. OAuth Apps → New OAuth App.
3. Indique:
4. Homepage URL: http://localhost:8001/
5. Authorization callback URL: http://localhost:8001/login?third_party_login=github
6. Registre la aplicación y copie el Client ID y el Client Secret.

2. Configurar omegaUp

1. Cree o edite frontend/server/config.php (solo local; no suba secretos a git).
2. Añada:

<?php
define('OMEGAUP_GITHUB_CLIENT_ID', 'your_real_client_id_here');
define('OMEGAUP_GITHUB_CLIENT_SECRET', 'your_real_client_secret_here');

1. Si el botón sigue desactivado, reinicie el contenedor frontend una vez.

Véase también Seguridad → integración OAuth.

Problemas comunes

La aplicación web no muestra mis cambios

Asegúrese de que Docker se esté ejecutando:

docker compose up --no-build

El navegador redirige HTTP a HTTPS

Si su navegador sigue cambiando http a https para localhost, puede desactivar las políticas de seguridad para localhost. Consulte esta guía.

Error de MySQL no encontrado

Si encuentra este error al ingresar a GitHub:

FileNotFoundError: [Errno 2] No such file or directory: '/usr/bin/mysql'

sudo apt-get install mysql-client mysql-server

cat > ~/.mysql.docker.cnf <<EOF
[client]
port=13306
host=127.0.0.1
protocol=tcp
user=root
password=omegaup
EOF
ln -sf ~/.mysql.docker.cnf .my.cnf

Error de conexión MySQL

Si MySQL está instalado pero aparece un error de socket local, los hooks que se ejecutan en git push esperan un cliente TCP hacia el puerto Docker 13306. Use el bloque ~/.mysql.docker.cnf y el enlace .my.cnf descritos en Contribuyendo → Configuraciones adicionales.

Submódulos Git / JS de terceros

Si faltan módulos bajo frontend/www/third_party/js/:

git submodule update --init --recursive

Reconstruir la imagen frontend

Tras cambios grandes de dependencias:

docker compose build frontend
docker compose up

Permisos: phpminiadmin, venv o reinicios en bucle

Causa: clon o docker compose como root o carpeta del proyecto propiedad de root.

Solución: como usuario normal, vuelva a clonar bajo su home, pertenezca al grupo docker y ejecute docker compose sin sudo. No use sudo git clone.

Errores de policy-tool / mysql al hacer push

Instale el cliente MySQL en el anfitrión y configure TCP como arriba. Para el entorno de despliegue, abra un issue en omegaup/deploy.

Próximos pasos

• Aprenda cómo contribuir - Cree sucursales y envíe solicitudes de extracción
• Revisar las pautas de codificación - Comprenda nuestros estándares de codificación
• Explora la arquitectura - Entiende cómo funciona omegaUp

Obtener ayuda

Si encuentra problemas que no se tratan aquí:

1. Consulte la Guía para obtener ayuda
2. Busque issues existentes en GitHub
3. Pregunte en nuestro servidor de Discord

¿Listo para comenzar a codificar? Dirígete a la Guía de contribución para saber cómo enviar tu primera solicitud de extracción.