Onboarding

Esta guía es para un programador que se incorpora al proyecto.

1. Herramientas

Instalar:

• PHP 8.4 y Composer 2.
• Node.js 20+ y pnpm.
• Docker Desktop.
• PostgreSQL 16+ y Redis (o usar los contenedores del proyecto).
• AWS CLI, gh y Git.
• Editor con soporte para PHP, Svelte y TypeScript.

2. Repositorios

Clonar los proyectos activos según el área:

mkdir -p ~/Sites/vortex-play
cd ~/Sites/vortex-play

git clone git@github.com:VortexPlayDev/platform-api.git
# Repo platform-backoffice; en este workspace se usa la carpeta platform-admin
git clone git@github.com:VortexPlayDev/platform-backoffice.git platform-admin
git clone git@github.com:VortexPlayDev/platform-front-svelte.git
git clone git@github.com:VortexPlayDev/blueocean.git integrations/blueocean
git clone git@github.com:VortexPlayDev/aggreg88.git integrations/aggreg88
git clone git@github.com:VortexPlayDev/lucky-spins.git integrations/lucky-spins
git clone git@github.com:VortexPlayDev/slots-api.git
git clone git@github.com:VortexPlayDev/slots-admin.git
git clone git@github.com:VortexPlayDev/zeus-treasures.git
git clone git@github.com:VortexPlayDev/platform-utils.git packages/platform-utils

Las lambdas están en lambda/:

git clone git@github.com:VortexPlayDev/balance-websocket.git lambda/balance-websocket
git clone git@github.com:VortexPlayDev/summary-stats.git lambda/summary-stats
git clone git@github.com:VortexPlayDev/tickets-data-export.git lambda/tickets-data-export
git clone git@github.com:VortexPlayDev/users-sync.git lambda/users-sync

platform-bo está archivado y no se clona para desarrollo nuevo.

3. Primer proyecto

Para Laravel:

cd platform-api
cp .env.example .env
composer install
php artisan key:generate
php artisan migrate
php artisan test
php artisan serve

Para el front:

cd platform-front-svelte
pnpm install
pnpm dev

Para slots:

cd slots-api
composer setup
composer octane:start

slots-api usa FrankenPHP. Si no tienes el binario en el PATH, usa el Dockerfile del proyecto o ejecuta php artisan octane:install --server=frankenphp.

Revisar el README.md y el AGENTS.md de cada proyecto antes de tocar código.

4. Convenciones que debes leer

• Arquitectura general
• Multi-tenant
• Entornos
• AGENTS.md del proyecto que vayas a modificar.
• Contrato de API: platform-api/docs/api-contract.md.

5. Primeras tareas recomendadas

1. Levantar platform-api y platform-front-svelte.
2. Hacer login con un usuario de prueba.
3. Revisar una ruta del contrato de API y su implementación.
4. Ejecutar los tests de un proyecto.
5. Hacer un cambio pequeño de documentación y abrir un PR.

6. Dónde pedir ayuda

• Arquitectura y API: responsable de platform-api.
• BackOffice: responsable de platform-backoffice.
• Front: responsable de platform-front-svelte.
• Integraciones: responsable de cada integración.
• Slots: responsable de slots-api / slots-admin / zeus-treasures.
• Infraestructura y AWS: responsable de plataforma.