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

npm install

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

# 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

# Ejecutar tests
npm test

# Verificar código
npm run lint

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

npm test

docker build -t my-trivia-node-app --target dev .

docker build -t my-trivia-node-app --target prod .

docker run -p 3000:3000 my-trivia-node-app 

docker run --env-file .env -p 3000:3000 my-trivia-node-app 

docker-compose up --build

npm run lint

📂 PROYECTO-DEVOPS
├── 📂.github
│   └── 📂 workflows                    # Contiene los archivos de CI/CD para GitHub Actions
│       ├── node.js.yml                 # Pipeline de CI y CD para la construccion, subida a docker hub y el deploy en flyio o render
│       └── release.yml                 # Archvio que se encarga de hacer un release automatico en github
│
├── 📂 media                            # Contiene imagenes para el readme
├── 📂 src                              # Contiene el código fuente de la aplicación
│   ├── app.js                          # Archivo de arranque del proyecto
│   ├── 📂 account                      # Contiene el manejo de cuentas de los usuarios
│   │   ├── 📂 oauthSystem              # Manejo de todo lo referido a OAuth de terceros
│   │   │   ├── deleteUsersAuth.js      # Cron job de eliminadion de usuarios que se encuentran en redis
│   │   │   └── oauthConfig             # Configuracion de las plataformas que estan disponibles para logearse mediante OAuth
│   │   │
│   │   ├── 📂 roles                    # Contiene los archivos que manejan los roles
│   │   │   ├── roleMiddleware.js       # Intermediario en controlar y verificar los roles y accesos
│   │   │   └── rolesManager.js         # Clase donde se manejan la jerarquia y cada tipo de rol
│   │   │
│   │   ├── authSupabase.js             # Archivo de inicializacion y configuracion con supabase
│   │   ├── login.js                    # Archvio para iniciar sesion y administrar tokens
│   │   ├── index.ejs                   # Configuracion para front end de login y registro
│   │   ├── register.js                 # Archivo que registra a los usuarios y valida los campos
│   │   ├── sessionHandler.js           # Manejo de sesiones de los usuarios
│   │   ├── tokenRefresh.js             # Actualizacion del token para mantener sesiones activas por un periodo mas prolongado
│   │   └── userUtils.js                # Funciones para el manejo en archivos interconectados (evitar dependencia circular)
│   │   
│   ├── 📂 controllers                  # Contiene archivos de controladores
│   │   └── triviaControllers.js        # Archvio que es intermediario entre routes y queries
│   │   
│   ├── 📂 dbFiles                      # Contiene archvios de la base de datos
│   │   ├── 📂 creatingTables           # Contiene archivos de la creacion de las tablas automaticas
│   │   │   └── userTables.js           # Nombres de tablas y campos de cada una
│   │   │
│   │   ├── 📂 monitoring               # Contiene los archvios correspondientes al monitoreo de la api
│   │   │   └── sentryConfig.js         # Configuracion para la conexion con Sentry
│   │   │
│   │   ├── databaseManager.js          # Archivo que se encarga de realizar la conexion a pg al iniciar
│   │   ├── queries.js                  # Archvio que realiza las consultas a la BD postgres
│   │   ├── queriesRedis.js             # Archvio que realiza las consultas a redis
│   │   └── redisManager.js             # Manejo principal de redis, se encarga de la conexion y las transacciones con la misma
│   │
│   ├── 📂 monitoring
│   │   └── sentryConfig.js             # Manejo y configuracion de la conexion con Sentry
│   │   
│   ├── 📂 routes                       # Contiene los archvos que manejan las rutas
│   │   ├── apiRoutesDoc.yaml           # Explica como comunicarse con cada ruta
│   │   ├── routes.js                   # Todas las rutas del proyecto
│   │   ├── securityRoutes.js           # Maneja la seguridad de las rutas
│   │   └── swaggerDocs.js              # Se encarga de la interfaz de apiRoutesDoc.yaml
│   │   
│   └── 📂 scrapQuotes                  # Contiene los archivos de las frases
│       ├── characters_simpsons.csv     # Tiene los personajes de la serie animada
│       └── quotes_simspons.csv         # Se encuentran las frases de la serie y su numero de personaje
│
├── 📂 views                            # Visualizaciones de las diferentes etapas del front para pruebas del back
│   ├── account.ejs                     # Funcionamiento de la pagina cuenta (registro/login/OAuth)
│   ├── index.ejs                       # Pagina principal con la api y redireccion a login y juego
│   ├── profile.ejs                     # Perfil del usuario con datos o info
│   └── trivia.js                       # Pagina de juego
│
├── 📂 tests                            # Contiene todos los tests
│   └── queries.test.js                 # Archivo que tiene y realiza los tests del proyecto
│
├── .dockerignore                       # Archivos o carpetas que docker debe ignorar o no incluir
├── .env.template                       # Plantilla para las variables de entorno
├── .gitignore                          # Archvios que no se suben a github
├── changelog.md                        # Cambios que se realizan en cada version
├── CLAUDE.md                           # Archivo de configuraciones basicas de claude code para entendimiento del proyecto
├── config.js                           # Manejo principal por el cual se van a transmitir las variables de entorno (es un puente entre el .env y los archivos) para un mejor desempeño de la solucion y evitar concurrencia.
├── docker-compose.yml                  # Configuración de Docker Compose
├── Dockerfile                          # Archivo Docker para construir la imagen de la api
├── eslint.config.mjs                   # Configuracion de la dependencia EsLint
├── fly.toml                            # Configuracion para deploy en Fly.io
├── license.txt                         # Archivo de licencia del proyecto
│
├── package.json                        # Contiene las dependencias del proyecto y + configuraciones
├── package-lock.json                   # Maneja las dependencias
│
└── readme.md                           # Instrucciones principales de la api y usos