Note
Para ver la documentación completa de la app visita: Documentación Completa
Este proyecto se compone: - Proyecto de Laravel - Un directorio db-data (con los SQL) - Una carpeta testINSOMNIA con los tests de los endpoints usados en el front - Y un servidor (archivo en la raíz-->server.js) Node.JS, con Express y Socket.IO para la implementación del las partidas multijugador.
*Requisitos previos:*
*Tener Git y Docker instalados en tu sistema*.
- Clona el repositorio original:
git clone https://github.com/Patcire/tinyquestions-backend.git- En la terminal del proyecto raíz usa el comando:
docker-compose up-
Espera hasta que todos los contenedores se hayan creado y hayan finalizado las instalaciones de los comandos post-levantamiento.
Importante: Esto puede tomar varios minutos. -
Si quieres desplegar también el front-end visita el siguiente repo: https://github.com/Patcire/tinyquestions-frontend
Warning
Todas las rutas deben comenzar con: https://localhost:8001/ para probar en el despliegue local
Estos son los 22 endpoints usados actualmente por funcionalidades del front-end:
| Endpoint | Método | Descripción |
|---|---|---|
| /api/user/count | GET | Cuenta el número de usuarios |
| user/allpag?page={number} | GET | Obtiene todos los usuarios paginados |
| /api/user/create | POST | Crea un nuevo usuario |
| /api/user/userstat/{username} | PATCH | Actualiza estadísticas de un usuario |
| /api/user/login | POST | Inicia sesión de un usuario |
| /api/match/create | POST | Crea un nuevo partido |
| /api/play/{id_user}/{number_items} | GET | Obtiene partidos jugados por un usuario |
| /api/play/create | POST | Crea un nuevo registro de partido jugado |
| /api/quiz/create | POST | Crea un nuevo cuestionario |
| /api/cust/all | GET | Obtiene todos los cuestionarios personalizados |
| /api/cust/all/{id_user} | GET | Obtiene cuestionarios personalizados de un usuario |
| /api/cust/{id} | GET | Obtiene un cuestionario personalizado por ID |
| /api/cust/create | POST | Crea un cuestionario personalizado |
| /api/rand/create | POST | Crea un cuestionario aleatorio |
| /api/ques/allFrom/{id} | GET | Obtiene todas las preguntas de un cuestionario personalizado |
| /api/ques/rand/{number} | GET | Obtiene un número específico de preguntas al azar |
| /api/ques/create | POST | Crea una nueva pregunta |
| /api/li/likes/{fk_id_user} | GET | Obtiene los "me gusta" de un usuario |
| /api/li/give | POST | Da un "me gusta" |
| /api/li/dis/{fk_id_user}/{fk_id_quiz} | DELETE | Elimina un "me gusta" |
| /api/has/{id_quiz} | GET | Obtiene las preguntas de un cuestionario aleatorio |
| /api/has/create | POST | Crea una relación de 1 cuestionario aleatorio con una pregunta aleatorias |
Aun así la API cuenta con más endpoints funcionales para futuras implementaciones:
| Endpoint | Método | Descripción |
|---|---|---|
| /api/user/all | GET | Obtiene todos los usuarios |
| /api/user/stats/{order} | GET | Obtiene estadísticas de usuarios paginadas |
| /api/user/{username} | GET | Obtiene un usuario por su nombre de usuario |
| /api/user/del/{username} | DELETE | Elimina un usuario por su nombre de usuario |
| /api/user/upd/{username} | PATCH | Actualiza un usuario por su nombre de usuario |
| /api/user/allmat/{id}/{type?} | GET | Obtiene todos los partidos de un usuario |
| /api/match/all | GET | Obtiene todos los partidos |
| /api/match/allpag | GET | Obtiene todos los partidos paginados |
| /api/match/bytype/{type} | GET | Obtiene partidos por tipo |
| /api/match/relinfo/{id} | GET | Obtiene información relacionada con un partido |
| /api/quiz/all | GET | Obtiene todos los cuestionarios |
| /api/quiz/{id} | GET | Obtiene un cuestionario por su ID |
| /api/cust/del/{id} | DELETE | Elimina un cuestionario personalizado por ID |
| /api/cust/upd/{id} | PATCH | Actualiza un cuestionario personalizado por ID |
| /api/rand/{id} | GET | Obtiene un cuestionario aleatorio por ID |
| /api/ques/all/{type} | GET | Obtiene todas las preguntas por tipo |
| /api/ques/{id} | GET | Obtiene una pregunta por su ID |
| /api/ques/upd/{id} | PATCH | Actualiza una pregunta por su ID |
| /api/ques/del/{id} | DELETE | Elimina una pregunta por su ID |
| /api/li/by/{fk_id_quiz} | GET | Obtiene a quién le gustó un cuestionario |
| /api/has/all | GET | Obtiene todos los cuestionarios aleatorios con preguntas aleatorias |
