diff --git a/docker-compose.yml b/docker-compose.yml index 1c81a3e..08e84f3 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,18 +1,84 @@ version: '3' services: + mongodb: + container_name: mongodb-${teamname:-defaultASW} + image: mongo + profiles: ["dev", "prod"] + volumes: + - mongodb_data:/data/db + ports: + - "27017:27017" + networks: + - mynetwork + questionservice: container_name: questionservice-${teamname:-defaultASW} image: ghcr.io/arquisoft/wiq_es05a/questionservice:latest profiles: ["dev", "prod"] build: ./questionservice ports: - - "2500:2500" + - "8003:8003" + environment: + - ACCESS_CONTROL_ALLOW_ORIGIN=http://webapp:3000 + - ACCESS_CONTROL_ALLOW_ORIGIN=http://localhost:3000/game + networks: + - mynetwork + + authservice: + container_name: authservice-${teamname:-defaultASW} + image: ghcr.io/arquisoft/wiq_0/authservice:latest + profiles: ["dev", "prod"] + build: ./userservice/authservice + depends_on: + - mongodb + ports: + - "8002:8002" + networks: + - mynetwork + environment: + MONGODB_URI: mongodb://mongodb:27017/userdb + + userservice: + container_name: userservice-${teamname:-defaultASW} + image: ghcr.io/arquisoft/wiq_0/userservice:latest + profiles: ["dev", "prod"] + build: ./userservice/userservice + depends_on: + - mongodb + ports: + - "8001:8001" + networks: + - mynetwork + environment: + MONGODB_URI: mongodb://mongodb:27017/userdb + + gatewayservice: + container_name: gatewayservice-${teamname:-defaultASW} + image: ghcr.io/arquisoft/wiq_0/gatewayservice:latest + profiles: ["dev", "prod"] + build: ./gatewayservice + depends_on: + - mongodb + - userservice + - authservice + - questionservice + ports: + - "8000:8000" + networks: + - mynetwork + environment: + AUTH_SERVICE_URL: http://authservice:8002 + USER_SERVICE_URL: http://userservice:8001 + QUESTION_SERVICE_URL: http://questionservice:8001 + webapp: container_name: webapp-${teamname:-defaultASW} image: ghcr.io/arquisoft/wiq_es05a/webapp:latest profiles: ["dev", "prod"] build: ./webapp + depends_on: + - gatewayservice ports: - "3000:3000" diff --git a/docs/images/05_nivel_2.png b/docs/images/05_nivel_2.png index 2f6812c..1aee797 100644 Binary files a/docs/images/05_nivel_2.png and b/docs/images/05_nivel_2.png differ diff --git a/docs/images/05_sistema-general-caja-blanca.png b/docs/images/05_sistema-general-caja-blanca.png index 594f23c..9aac1fe 100644 Binary files a/docs/images/05_sistema-general-caja-blanca.png and b/docs/images/05_sistema-general-caja-blanca.png differ diff --git a/docs/src/01_introduction_and_goals.adoc b/docs/src/01_introduction_and_goals.adoc index 3a4ae93..cd8db0b 100644 --- a/docs/src/01_introduction_and_goals.adoc +++ b/docs/src/01_introduction_and_goals.adoc @@ -80,9 +80,9 @@ A table with quality goals and concrete scenarios, ordered by priorities [cols="e,2e" options="header"] |=== |Nombre|Descripción -|*Usabilidad*| _La aplicación tiene que poder usarse por el mayor tipo de usuarios_ +|*Usabilidad*| _La aplicación tiene que poder usarse por el mayor tipo de usuarios y ser intuitiva; tener una curva de aprendizaje suave y progresiva_ |*Rendimiento*| _El tiempo de respuesta de la aplicación debe ser rápido_ -|*Testeable*| _La aplicación debe pasar las pruebas generadas automaticamente para cada versión_ +|*Testeable*| _La aplicación debe facilitar la realizacion de pruebas de manera efectiva_ |*Disponibilidad*| _La aplicación debe estar disponible y caerse lo menos posible_ |=== === Stakeholders @@ -110,10 +110,10 @@ Table with role names, person names, and their expectations with respect to the [cols="e,2e,2e" options="header"] |=== |Rol/Nombre|Expectativa|Descripción -| *Cristian Augusto* | _Aplicar correctamente los conocimientos y competencias adquiridos en la asignatura Arquitectura del Software_ | _Profesor de la asignatura_ +| *Profesor* | _Aplicar correctamente los conocimientos y competencias adquiridos en la asignatura Arquitectura del Software_ | _Profesor de la asignatura_ | *HappySw* | _Una aplicación buena para atraer al mayor número de usuarios_ | _Equipo de desarrollo_ | *Wikidata* | _Usar su aplicacion con precaución, sin sobrecargar sus servicios_ | _Empresa que nos facilita la API para obtener información_ -| *Usuarios Registrados* | _Una aplicación que proporcione los servicios esperados_ | _Los usuarios de la aplicación_ -| *Usuarios No Registrados* | _Una buena aplicación_ | _Los usuarios de la aplicación_ -| *RTVE* | _Una buena versión de su juego "Saber y Ganar"_ | _Dueño del producto_ +| *Usuarios Registrados* | _Una aplicación que les permita jugar a un juego de preguntas y respuestas_ | _Los usuarios que ya se han registrado en la aplicación y pueden acceder a sus servicios_ +| *Usuarios No Registrados* | _Poder registrarse lo más rápido posible para empezar a jugar al juego de preguntas y respuestas_ | _Los usuarios que aun no se han registrado en la aplicación y no tienen acceso a sus servicios_ +| *RTVE* | _Una buena versión de su juego "Saber y Ganar" para mejorar la audiencia del programa_ | _Dueño del producto_ |=== diff --git a/docs/src/02_architecture_constraints.adoc b/docs/src/02_architecture_constraints.adoc index 7514a70..cd0e9c1 100644 --- a/docs/src/02_architecture_constraints.adoc +++ b/docs/src/02_architecture_constraints.adoc @@ -36,16 +36,15 @@ Por ello esta aplicación está desarrollada siguiendo una serie de limitaciones |Restricción |Explicación |*GIT* -|_En la asignatura se requiere el uso del sistema de control de versiones GIT, además de emplear GitHub como repositorio. Además nos permite -una continua integración mediante la paralelización del trabajo usando el sistema de ramas. También GitHub permite organizar las distintas tareas de cada -miembro del equipo mediante el uso de las Issues._ +|_En la asignatura se requiere el uso del sistema de control de versiones GIT, además de emplear GitHub como repositorio. Asimismo, nos permite +una continua integración de forma remota mediante la paralelización del trabajo usando el sistema de ramas._ |*Docker* -|_Esta tecnología de contenerización es utilizada para desplegar la aplicación web tanto en el entorno de desarrollo como en el de producción +|_Esta tecnología de contenerización será requerida ya que la usaremos para desplegar la aplicación web tanto en el entorno de desarrollo como en el de producción y realizar las pruebas pertinentes._ |*Wikidata* -|_Fuente de información utilizada para generar aleatoriamente tanto las preguntas como las respuestas correctas e incorrectas del juego._ +|_En la asignatura se requiere que esta sea la fuente de información principal para generar aleatoriamente tanto las preguntas como las respuestas correctas e incorrectas del juego._ |=== === Limitaciones organizativas @@ -66,6 +65,16 @@ con alguna de estas._ |*Reuniones* |_Para mantener un buen ritmo de trabajo a través de una correcta organización se realizan reuniones semanales en las clases prácticas de la asignatura. Además, mantenemos contacto a través de nuestro grupo de WhatsApp y en casos necesarios realizamos reuniones extraordinarias utilizando nuestro servidor de Discord._ + +|*Issues* +|_Para el seguimiento y la gestión de las tareas, problemas, mejoras, autoinformes, etc. de la aplicación tendremos que usar las issues ofrecidas por github; esto es una obligación ya + que reflejara el trabajo realizado por cada miembro del equipo al poder asignarse cada issue._ + +|*Actas* +|_Al igual que las issues, las actas servirán para la organización de las tareas asi como para la toma de decisiones, y tendrán + que reflejar el trabajo repartido a cada miembro. Se deberán realizar obligatoriamente cada vez que se realice una reunión y deberán constar los miembros del + equipo que han participado._ + |=== === Convenciones @@ -75,19 +84,19 @@ a través de nuestro grupo de WhatsApp y en casos necesarios realizamos reunione |Restricción |Explicación |*Diseño del software* -|_Para lograr un buen diseño es indispensable que el código de la aplicación sea flexible, mantenible y comprensible._ +|_Para lograr un buen diseño es indispensable que el código de la aplicación sea flexible, mantenible y comprensible. Además se espera un código limpio ('clean code'), +es decir, que sea fácil de entender, mantener y modificar, y que garantize la claridad, simplicidad y legibilidad._ |*Documentación* |_Para crearla usaremos la plantilla Arc42 con la finalidad de que sea sencilla y práctica._ |*Accesibilidad* -|_Intentaremos que nuestra aplicación puede ser utilizada por cualquier tipo de usuario, sin importar quién sea. Seguiremos el estándard WCAG de la W3C, -usando el color, tamaño de texto... adecuados para ello._ +|_Intentaremos que nuestra aplicación puede ser utilizada por cualquier tipo de usuario, sin importar quién sea._ |*Estructura* -|_Debe seguir una estructura fija y bajo los mismos estandares. Los diferentes modulos estarán separados en carpetas -principalmente: 'users' para la api rest y el registro de usuarios, 'webapp' para el desarrollo de la aplicación, 'docs' -para la documentación._ +|_Debe seguir una estructura fija y bajo los mismos estandares. Los diferentes modulos estarán separados en carpetas: 'userservice' para la gestión de +usuarios (registro y autentificación), 'questionservice' para la comunicación con wikidata y 'webapp' para el desarrollo de la aplicación. Todos estos +servicios estarán comunicados por 'gatewayservice'._ |*Convenciones del lenguaje de programación* |_Es fundamental adherirse a las convenciones de los diferentes lenguajes de programación utilizados para garantizar que la aplicación tenga un código legible, diff --git a/docs/src/05_building_block_view.adoc b/docs/src/05_building_block_view.adoc index a3bbb5b..2c3dccb 100644 --- a/docs/src/05_building_block_view.adoc +++ b/docs/src/05_building_block_view.adoc @@ -89,8 +89,6 @@ Bloques de construcción contenidos:: |*Wikidata* |_Servicio externo desde donde obtenemos los datos para generar las preguntas._ -|*Firebase* -|_Plataforma para el manejo de sesiones de los usuarios, asi como informacion sobre sus estadisticas._ |=== === Nivel 2: WIQ @@ -102,11 +100,24 @@ Bloques de construcción contenidos:: |=== |Nombre |Responsabilidad -|*Webapp* +|*webapp* |_La interfaz con la que interactua el usuario._ -|*REST* -|_Manejo de datos de Wikidata._ +|*gatewayservice* +|_Servicio de puerta de enlace que actúa como intermediario entre los clientes y otros servicios, +reenviando las solicitudes a los servicios correspondientes y devolviendo las respuestas al cliente._ + +|*authservice* +|_Servicio de autenticación de usuarios._ + +|*userservice* +|_Servicio para registro de usuarios._ + +|*questionservice* +|_Servicio para el manejo de datos de Wikidata._ + +|*Wikidata* +|_Servicio externo desde donde obtenemos los datos para generar las preguntas._ |=== diff --git a/docs/src/07_deployment_view.adoc b/docs/src/07_deployment_view.adoc index 82b0167..a032bd1 100644 --- a/docs/src/07_deployment_view.adoc +++ b/docs/src/07_deployment_view.adoc @@ -81,11 +81,11 @@ Mapeo de bloques de construcción a infraestructura:: |*WebApp* |Microservicio responsable de las vistas de la aplicación y sus interacciones con el usuario. -|*Rest* +|*QuestionService* |Microservicio responsable de generar preguntas y respuestas utilizando la información de Wikidata, almacenándola posteriormente en una base de datos MySQL. -|*Users* +|*UserService* |Microservicio encargado de gestionar los diferentes usuarios y sus partidas realizadas haciendo uso de la API Firebase. |*Navegador Web* diff --git a/docs/src/11_technical_risks.adoc b/docs/src/11_technical_risks.adoc index a04dc64..def2c95 100644 --- a/docs/src/11_technical_risks.adoc +++ b/docs/src/11_technical_risks.adoc @@ -24,6 +24,7 @@ See https://docs.arc42.org/section-11/[Risks and Technical Debt] in the arc42 do **** === Riesgos Técnicos +==== Riesgos internos [cols="e,2e" options="header"] |=== @@ -37,10 +38,18 @@ de trabajo de los demás compañeros._ |_Las demás asignaturas en la que están matriculados los miembros del equipo puede exigir una carga importante de trabajo por lo que provocar que el equipo no dedique el suficiente tiempo al desarrollo de este proyecto._ -|*Errores* -|_Durante las pruebas de la aplicación pueden surgir errores que nos obliguen a realizar importantes cambios en esta. Esto puede provocar que el equipo invierta más horas de +|*Errores de diseño* +|_Los errores que surjan debido al diseño, implementacion o gestion interna del proyecto; nos obligarán a realizar cambios e invertir más horas de las planeadas para solucionar este tipo de problemas._ +|=== + +==== Riesgos externos + +[cols="e,2e" options="header"] +|=== +|Riesgo |Explicación + |*Caída de Servicios* |_Nuestra aplicacion web puede verse comprometida a errores si alguno de los servicios utilizados, como por ejemplo Docker, parará de funcionar en algún momento. Ya que los servicios no son creados por nosotros no podemos saber si estarán disponibles en todo momento por lo tanto @@ -54,5 +63,6 @@ esto podría bloquear la entrega de alguna de las funcionalidades del proyecto._ |=== +=== Deudas Técnicas - +TODO \ No newline at end of file diff --git a/questionservice/server.js b/questionservice/server.js index 4b7d2ed..fbfacb3 100644 --- a/questionservice/server.js +++ b/questionservice/server.js @@ -54,7 +54,7 @@ app.get('/pregunta', async (req, res) => { res.json({ question, answerGood, answers }); }); -// Iniciamos el servidor en el puerto 3000 +// Iniciamos el servidor en el puerto 8003 const server = app.listen(8003, () => console.log('El servidor está escuchando en el puerto 8003')); module.exports = server \ No newline at end of file diff --git a/webapp/src/components/Pages/Juego.js b/webapp/src/components/Pages/Juego.js index 99949fb..0557d24 100644 --- a/webapp/src/components/Pages/Juego.js +++ b/webapp/src/components/Pages/Juego.js @@ -24,7 +24,7 @@ const Juego = ({isLogged}) => { //Esta operación es llamada cuando pregunta esté vacia. useEffect( () => { const crear = async () => { - const response = await axios.get('http://localhost:8000/pregunta'); + const response = await axios.get('http://localhost:8003/pregunta'); setPregunta(response.data.question) setResCorr(response.data.answerGood) setResFalse(response.data.answers)