Merge pull request #41 from Arquisoft/develop

Arquisoft · Feb 25, 2024 · aaaf69d · aaaf69d
2 parents 2ae680e + 6f874a8
commit aaaf69d
Show file tree

Hide file tree

Showing 31 changed files with 6,006 additions and 299 deletions.
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -11,6 +11,20 @@ services:
     networks:
       - mynetwork
 
+  creationervice:
+    container_name: creationservice-${teamname:-defaultASW}
+    image: ghcr.io/arquisoft/wiq_es2b/creationservice:latest
+    profiles: ["dev", "prod"]
+    build: ./questions/creationservice
+    depends_on:
+      - mongodb
+    ports:
+      - "8005:8005"
+    networks:
+      - mynetwork
+    environment:
+      MONGODB_URI: mongodb://mongodb:27017/userdb
+
   authservice:
     container_name: authservice-${teamname:-defaultASW}
     image: ghcr.io/arquisoft/wiq_es2b/authservice:latest

diff --git a/docs/images/03-BusinessContextDiagram-Lucidchart.png b/docs/images/03-BusinessContextDiagram-Lucidchart.png
diff --git a/docs/images/03-TechnicalContextDiagram-Lucidchart.png b/docs/images/03-TechnicalContextDiagram-Lucidchart.png
diff --git a/docs/images/07-Deployment View.drawio.png b/docs/images/07-Deployment View.drawio.png
diff --git a/docs/images/DOCsection5-1.png b/docs/images/DOCsection5-1.png
diff --git a/docs/images/DOCsection5-2.png b/docs/images/DOCsection5-2.png
diff --git a/docs/images/DOCsection5-3.png b/docs/images/DOCsection5-3.png
diff --git a/docs/images/DOCsection8-1.png b/docs/images/DOCsection8-1.png
diff --git a/docs/images/DeplymentViewTest.drawio.png b/docs/images/DeplymentViewTest.drawio.png
diff --git a/docs/src/01_introduction_and_goals.adoc b/docs/src/01_introduction_and_goals.adoc
@@ -30,7 +30,7 @@ It consists of an application in which users can register and enter to play the
 [options="header",cols="1,2"]
 |===
 |Goals|Details
-| _Privacity_ | _The data of registered users will be saved, ensuring their security_ 
+| _Performance_ | _We are going to need the application to have a good performance since we are going to make several calls and we need that these calls do not take too much time for the system to be efficient and dynamic during its use_ 
 | _Usability_ | _The use of the application must be an intuitive and simple process for the client user_
 | _Maintainability_ | _We will try to take care of the architecture of the application so that functionality can be added, modified or removed with as few changes as possible_
 | _Testeability_| _Our application may also be testable, that is, it will be subjected to a series of unit tests that we will perform to ensure proper operation of the system, in addition to identifying small errors and being able to correct them in such a case_

diff --git a/docs/src/03_system_scope_and_context.adoc b/docs/src/03_system_scope_and_context.adoc
@@ -8,37 +8,36 @@ ifndef::imagesdir[:imagesdir: ../images]
 === Business Context
 
 
-
-image::03-BusinessContextDiagram-Lucidchart.png[Business Context Diagram]
+image::03-BusinessContextDiagram-Lucidchart.png[title="Business Context Diagram"]
 
 
 .WIQ
-[cols="1,2,3"]
+[cols="1,2"]
 |===
 
 |*Comunication Partner*
-|*Inputs*
-|*Outputs*
+|*Description*
 
 | User
-| Registration and participation in the competition
-| Quiz results, correct and wrong questions, times and statistics
+| Registration and participation in the competition and 1uiz results, correct and wrong questions, times and statistics.
 
 | Database
-| Queries and user-related writing and questions
-| System-related results, questions and users
+| Queries and user-related writing and questions and system-related results, questions and users.
 
 | Wikidata
-| Requesting data for question generation from properties and categories
-| Data to generate questions and answers
+| Requesting data for question generation from properties and categories and data to generate questions and answers.
 
 | User's API
-| Request user information
-| User data, history and game statistics
+| Request user information and user data, history and game statistics.
 
 | Question's API
-| Request generated questions
-| History of generated questions and answers
+| Request generated questions and history of generated questions and answers
+
+| Graphana
+| Visualization and analytics of data integrates with Prometheus to create dashboards and display metrics.
+
+| Prometheus
+| Monitoring time-series data of the application. Used to gather metrics related to the performance and health of the system.
 |===
 
 The agents involved in the WIQ system environment are the following:
@@ -53,7 +52,7 @@ The agents involved in the WIQ system environment are the following:
 
 * *Question's API*: is given by the system to provide information about the questions generated.
 
-
+* *Grafana and Prometheus*: are used to collect data about the application and display the metrics obtained.
 
 
 === Technical Context
@@ -84,15 +83,19 @@ image::03-TechnicalContextDiagram-Lucidchart.png[Technical Context Diagram]
 
 | HTTP/REST
 | Input
-| Database -> Wikidata
+| WIQ -> Wikidata
 
 | HTTP
 | Input
-| Database -> WIQ
+| WIQ -> Database communication
+
+| HTTP
+| Output
+| WIQ -> Database communication
 
 | HTTP
 | Output
-| WIQ -> Database
+| WIQ -> Data monitoring and visualization
 
 |===
 

diff --git a/docs/src/04_solution_strategy.adoc b/docs/src/04_solution_strategy.adoc
@@ -20,13 +20,13 @@ ifndef::imagesdir[:imagesdir: ../images]
 
 === Decisions on how to achieve key quality goals
 
-* Usability: the team will take care to design a clear and accessible interface for any user. This will be based on web usability standards.
+* Usability: The team will take care to design a clear and accessible interface for any user. This will be based on web usability standards.
 
-* Privacy: users' private information will be stored in such a way that it will not be accessible to external factors.
+* Performance: Minimize delays in data processing, communication, or task execution to improve overall system responsiveness. As well, optimize system components, algorithms, and configurations.
 
-* Security: we will take care to implement all the measures we deem appropriate to secure our application.
+* Maintainbility: The architecture of the application must allow new functionalities to be added or existing ones to be modified with as few changes as possible.
 
-* Testability: this is an important quality objective to ensure that the software is reliable, robust and error-free. It is important to implement appropriate software development practices, such as separation of concerns and modular design.
+* Testability: This is an important quality objective to ensure that the software is reliable, robust and error-free. It is important to implement appropriate software development practices, such as separation of concerns and modular design.
 
 === Relevant Organizational Decisions