diff --git a/images/Context Diagram.png b/images/Context Diagram.png index 6371b3c..969dd79 100644 Binary files a/images/Context Diagram.png and b/images/Context Diagram.png differ diff --git a/images/Deployment view L2.png b/images/Deployment view L2.png index f343612..8534e30 100644 Binary files a/images/Deployment view L2.png and b/images/Deployment view L2.png differ diff --git a/images/Questions API (WhiteBox).png b/images/Questions API (WhiteBox).png new file mode 100644 index 0000000..4b7eb84 Binary files /dev/null and b/images/Questions API (WhiteBox).png differ diff --git a/images/Whitebox overall system.png b/images/Whitebox overall system.png index 73396d1..44349f9 100644 Binary files a/images/Whitebox overall system.png and b/images/Whitebox overall system.png differ diff --git a/images/playing_diagram.png b/images/playing_diagram.png index b2dd672..74f9024 100644 Binary files a/images/playing_diagram.png and b/images/playing_diagram.png differ diff --git a/images/questions API (WhiteBox).png b/images/questions API (WhiteBox).png deleted file mode 100644 index 627739c..0000000 Binary files a/images/questions API (WhiteBox).png and /dev/null differ diff --git a/index.html b/index.html index b82ab98..7073e03 100644 --- a/index.html +++ b/index.html @@ -479,8 +479,9 @@

arc42 T
  • 8. Cross-cutting Concepts
  • 9. Architecture Decisions
  • @@ -575,7 +576,12 @@

    1. Introduction and Goals

    -

    In these points, the main goals and functional requirements will be explained. In order to give context on how the webapp will be developed.

    +

    This project’s aim, in summary, is developing a public web application which has a game consisting on answering multiple choice questions +with one correct answer generated using Wikidata. For reference of the general mechanic, see the spanish quiz program 'Saber y Ganar' and +its game mode 'Descartando'

    +
    +
    +

    Next, important basic aspects of the project will be described in order to give context on how the webapp will be developed.

    1.1. Requirements Overview

    @@ -826,7 +832,7 @@

    1.3. Stakeholders

    Role/Name -Contact +Members Expectations @@ -842,11 +848,6 @@

    1.3. Stakeholders

    In charge of supervising the student’s teamwork, ensuring the work accomplishes the goals in the best way possible and helping in the development and solving doubts.

    -

    Bussineses

    -

    RTve has hired software development company HappySw

    -

    Emphasis the SOLID part of the web and have a high understanding of this area

    - -

    Users

    Anyone that wants to use the web

    They should be able to understand how to use and move around the web with ease

    @@ -996,7 +997,7 @@

    3.1. Business Context

    -Context Diagram +Context Diagram
    @@ -1024,17 +1025,17 @@

    3.1. Business Context

    - - - - - + + + + +

    External data repository from which questions are generated

    MongoDB

    Database for storing players' info and scores

    Users Info API

    Manages data of users, both registration/login data and their past scores

    questions API

    Questions API

    Manages generation of questions from Wikidata

    MongoDB

    Database for storing players' info and scores

    @@ -1225,7 +1226,7 @@

    5.1. Whitebox Overall System

    -Whitebox overall system +Whitebox overall system
    @@ -1350,7 +1351,7 @@

    5.2. Level 2

    -

    5.2.1. questions API (White Box)

    +

    5.2.1. Questions API (White Box)

    This is the Component that holds the functionallity for the main purpose of the webapp: Allowing players to see questions and answer them, getting a consequent score update.

    @@ -1364,7 +1365,7 @@

    5.2.1. questions API (White Box)

    -questions API (WhiteBox) +Questions API (WhiteBox)
    @@ -1396,10 +1397,6 @@

    5.2.1. questions API (White Box)

    wikibase-sdk

    External library that facilitates and simplifies the use of wikidata for the generation of questions.

    - -

    MongoDB

    -

    Data about users and their scores is stored here

    -
    @@ -1449,7 +1446,7 @@

    6.3. Playing

    -playing diagram +playing diagram
    @@ -1631,7 +1628,7 @@

    7.2. Infrastructure Level 2

    7.2.1. WIQ Server

    -Deployment view L2 +Deployment view L2
    @@ -1745,7 +1742,17 @@

    8. Cross-cutting Concepts

    -

    8.1. Microservice based system

    +

    8.1. Continuous integration and development

    +
    +

    Our way of working with github is having one developing branch towards which all pull requests are done +and have to be reviewed by at least one team member. +Sonar Cloud is set up so we know the testing coverage and whether we pass the quality gate with every pull request. +Once there is enough change in the develop branch with respect to the main one and it has enough quality we can +merge them and make a release.

    +
    +
    +
    +

    8.2. Microservice based system

    Different business functionallities will be developed in different independent services. This will ensure that if one of them fails, the rest are still working (For example, @@ -1757,7 +1764,7 @@

    8.1. Microservice based system

    -

    8.2. Gateway service routing

    +

    8.3. Gateway service routing

    We will use a speciallized service that will route the requests to the corresponding service, acting as a single entry point for the application. Requests to the services are much simpler as only the api base