Trivia Simpsons ES latam 🍩

Este proyecto es un trabajo universitario presentado en la materia DevOps de la universidad de palermo.

🤓 Objetivo

Implementar diferentes herramientas en un proyecto que contemple el correcto funcionamiento del servicio, el cual sea alojado en la nube.

Esto nos va a servir para poder controlar y verificar el funcionamiento del mismo asi como tambien analizar las metricas, los testeos, manejo de CI/CD, creacion y configuracion de archivos docker.

🚀 Características Destacadas

🎮 Trivia Interactiva Completa | 👤 Sistema de Usuarios Avanzado | 🔗 OAuth Multi-Proveedor

Juega la trivia más divertida de Los Simpsons con autenticación moderna y gestión completa de usuarios

🔑 Acceso a la API -

🌐 Demo en Vivo

Podes acceder a la aplicación completa a través del siguiente 🔗 LINK

📚 Documentación API

Explora todos los endpoints disponibles en la 📖 Documentación Swagger integrada.

🙋‍♂️ Preguntas y Respuestas

El proyecto contempla la creacion de una trivia usando frases de los simpsons, la idea es adivinar la mayor cantidad de personajes en base a las frases brindadas en cada ronda.

El mismo cuenta con una base de datos que almacena la informacion de los jugadores/participantes.

🖥️ Backend & Core

• Runtime: Node.js v22.9.0
• Framework: Express.js v4.20.0
• Language: JavaScript (CommonJS)
• Package Manager: NPM v10.1.0

🗄️ Base de Datos & Storage

• Principal: PostgreSQL (via Supabase)
• Cache: Redis (Upstash/Local)
• Storage: Supabase Storage (imágenes de perfil)
• ORM: Queries SQL nativas

🔐 Autenticación & Seguridad

• Auth Provider: Supabase Auth
• OAuth: Google, GitHub
• Tokens: JWT con refresh automático
• Security: bcryptjs, express-rate-limit, express-brute
• CORS: Configuración personalizada

🧪 Testing & Quality

• Testing: Jest v29.7.0
• Linting: ESLint v9.11.1
• Load Testing: JMeter v5.6.3
• Code Quality: Pre-commit hooks

🚀 DevOps & Deployment

• Containerización: Docker (multi-stage)
• CI/CD: GitHub Actions
• Hosting: Fly.io (principal), Render (alternativo)
• Monitoring: Sentry, Grafana
• Docs: Swagger UI + YAML

🖥️ Frontend & UI

• Engine: EJS Templates
• Styling: CSS3 con Variables Customizadas
• Icons: Emoji + Provider Favicons
• Animations: CSS Transitions & Keyframes

🔧 Development Tools

• Dev Server: Nodemon v3.1.4
• Process Manager: PM2 (producción)
• Environment: Variables de entorno centralizadas
• Debugging: Console logs + Sentry tracking

🎮 Características Principales

• Consultar frases iconicas y famosas de la serie
• Acceder a los diferentes endpoints
• Consultar todos los personajes
• Consultar que frase pertenece a que personaje
• Consultar el estado de la api en health check
• Trivia completa funcional - Juego interactivo con puntuación
• Sistema de ranking - Mejor puntaje, último puntaje y estadísticas

👤 Sistema de Usuarios

• Registro y login tradicional - Email/contraseña
• Autenticación OAuth - Google y GitHub
• Vinculación de cuentas - Conecta múltiples proveedores OAuth
• Usuarios anónimos - Juega sin registrarte
• Gestión de sesiones - Tokens JWT con refresh automático
• Perfiles de usuario - Estadísticas personalizadas y gestión de cuenta

🔐 Seguridad y Administración

• Roles de usuario - Sistema de permisos (Admin/User/Guest)
• Rate limiting - Protección contra abuso de API
• Brute force protection - Seguridad en login
• Eliminación automática - Limpieza de usuarios temporales

📊 Características Técnicas

• Base de datos dual - PostgreSQL + Redis para rendimiento
• Monitoreo con Sentry - Tracking de errores en tiempo real
• CI/CD automatizado - GitHub Actions para deploy
• Documentación API - Swagger integrado
• Containerización - Docker multi-stage para dev/prod

🎯 Pendientes

• Consultar a que capitulo/temporada pertenece la frase
• Sistema de recompensas con imágenes de perfil
• Cache Redis para preguntas frecuentes
• Integración con IA para generar contenido

• Back end: Tomás Saint Romain

• Front end: 👀

📖 Documentación

Por mas que parezca tentador por favor no se coma la documentacion 🤤

🚀 Inicio Rápido

1️⃣ Clonar el repositorio

git clone https://github.com/TomasS-R/SimpsonsTrivia
cd SimpsonsTrivia

2️⃣ Instalar dependencias

npm install

3️⃣ Configurar variables de entorno

# Copia el template y configura tus variables
cp .env.template .env
# Edita .env con tus configuraciones

4️⃣ Ejecutar en desarrollo

# Opción 1: Con testing automático
npm run dev

# Opción 2: Solo servidor
npm start

# Opción 3: Modo manual
nodemon --env-file=.env src/app.js

5️⃣ Verificar funcionamiento

• 🌐 App: http://localhost:3000
• 📚 API Docs: http://localhost:3000/api/v1
• 🧪 Health Check: http://localhost:3000/api/v1/healthcheck

🧪 Testing & Quality

# Ejecutar tests
npm test

# Verificar código
npm run lint

# Ambos (usado en npm run dev)
npm test && npm run lint

Variables de entorno 💡

[!IMPORTANT] Al correr este proyecto puedes agregar las siguientes variables de entorno al archivo .env (debes crear este archivo, o cambiarle el nombre al archivo .env.template) ya sea que lo corras de forma local o en la nube ☁️ si completas los campos debes cambiar la variable CONNECTPOSTGRES y colocarla en True ya que si no, no tomara las variables de la Base de datos.

Variables de entorno para la conexion con postgress

Nombre	Valor default	Descripcion
DATABASEUSER	-	Campo usuario de la base de datos
DATABASEPASS	Tu constraseña	La contraseña de la base de datos
DATABASEHOST	-	El host que te provee la base de datos
DATABASEPORT	-	El puerto que te provee
DATABASENAME	postgress	El nombre que te provee

[!NOTE] Por defecto si no tiene valor correra en el puerto 3000

PORT=

[!NOTE] Por defecto tiene 'localhost:' debes cambiarlo al subirlo a la nube o puedes dejarlo vacio como en mi caso

HOST

[!NOTE] JWT_SECRET es para generar un json web token este lo debes generar tu mismo, puedes combinar letras y numeros o usar un generador de contraseñas

JWT_SECRET=

[!NOTE] Por defecto si no tiene valor asignado esta en False, en caso de haber cargado las variables colocarlo en True

CONNECTPOSTGRES=

[!NOTE] Dependiendo si se desplega en dev va a seguir por defecto en desarrollo, si no va a estar en produccion.

NODE_ENV=

[!NOTE] En mi caso lo coloque en flyio por lo que estara apuntando a simpsons-trivia.fly.dev pero debes colocar el tuyo segun la url que te entregue el proveedor.

URLHOST=

[!NOTE] Si no se ingresa ninguna url por default permitira todas las url´s, puedes colocar una o varias rutas de esta forma =https://www.url1.com,http://www.url2.com,http...

CORS_ORIGIN=

[!NOTE] Ingresa tu DSN de sentry si tienes y si quieres realizar un monitoreo de la api mas preciso, si no puedes dejarlo vacio!

SENTRY_DSN=

[!NOTE] Esto es opcional, pero si no lo configuras no podras manejar el login y el registro.

SUPABASE_URL=

[!NOTE] Esto es opcional, pero si no lo configuras no podras manejar el login y el registro. Esta clave la puedes encontrar en supabase.com/dashboard > Project API Keys > anon public

SUPABASE_ANON_KEY=

[!NOTE] Esta clave la puedes encontrar