Skip to content

Commit

Permalink
Changed the logo of the docu and fixed things
Browse files Browse the repository at this point in the history
  • Loading branch information
uo289029 committed Mar 7, 2024
1 parent f291f06 commit 00bf869
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 18 deletions.
Binary file added docs/images/logo192.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 1 addition & 10 deletions docs/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
// configure EN settings for asciidoc
include::src/config.adoc[]

= image:arc42-logo.png[arc42] WIQ!
= image:logo192.png[WIQ logo] WIQ!
:revnumber: 8.2 EN
:revdate: January 2023
:revremark: (based upon AsciiDoc version)
Expand All @@ -32,15 +32,6 @@ endif::backend-html5[]
// horizontal line
***

[role="arc42help"]
****
[NOTE]
====
This version of the template contains some help and explanations.
It is used for familiarization with arc42 and the understanding of the concepts.
For documentation of your own system you use better the _plain_ version.
====
****


// numbering from here on
Expand Down
6 changes: 3 additions & 3 deletions docs/src/02_architecture_constraints.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ ifndef::imagesdir[:imagesdir: ../images]
|Technical Constraint |Reason
|Web app | The application we are developing is a web game called WIQ consisting of automatically generated questions and answers. Users, once logged in, must answer within a certain time to win prizes.
Additionally, users will also have access to the history of their games.
|Documentation | PlantUML and ASCIIDoc will be used along with the Arc42 template to keep the documentation updated throughout the development of the web app.
|Documentation | Diagrams and ASCIIDoc will be used along with the Arc42 template to keep the documentation updated throughout the development of the web app.
|SPARQL | To generate the questions and answers for the game, we will use SPARQL in Wikidata as it is a great source of information to provide
different types of questions to the users, making the game versatile and non-repetitive.
|Question generator | Using the Wikidata API, questions will be automatically generated along with the correct and three incorrect answers. This questions will be
|Question generator | Using the Sparql querys, questions will be automatically generated along with the correct and three incorrect answers. This questions will be
answered by the user and saved in their history. By using this generator, we ensure that the likelihood of getting the same question in another game is almost none.
|Users Login| The login of the users must be the first thing that shows up when you open the web of the game. Users will be able to register and to log in. After registering, it will be necessary to log in to access the website and start the game.
Users who already have an account will have the option to start the game or view their data from previus games (number of games, correct and incorrect answers, time played, etc).
|Deployment | The web app must have a frontend to interact with the game through a web interface, which will be deployed in a virtual machine. To deploy locally
for testing before releasing, we will use Docker
for testing before releasing, we will use Docker and npm.
|===

[options="header",cols="1,2"]
Expand Down
2 changes: 1 addition & 1 deletion docs/src/04_solution_strategy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Summary and explanation of the fundamental decisions and solution strategies tha
=== Technology decisions
* Javascript as the programming language. It was chosen as the best option among the others we considered (Java, Spring Boot, etc) as it is well-suited for using APIs easily and is a simple language.
* React.js as the Javascript library chosen to program the user interface of the app due to its ease of use and popularity nowadays.
* Wikidata API to use in the question generator, as it is a requirement of the app.
* Sparql with Wikidata to use in the question generator, as it is a requirement of the app.
* Docker for deploying de app locally and testing it.

=== Top-level decomposition of the system decisions
Expand Down
6 changes: 2 additions & 4 deletions docs/src/05_building_block_view.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@ Contained Building Blocks::
|Wikidata | The external source of information that the webApp uses to generate que questions.
|===

Important Interfaces::
There are not important interfaces in this diagram.

==== WebApp

Expand All @@ -40,7 +38,7 @@ The interface of the WebApp will be the frontend of a web that will be seen bett
==== Wikdata

The purpose of the Wikidata box is to get the necessary information to generate all the questions of all the games.
The game will interact with Wikidata by its API.
The game will interact with Wikidata by sparql querys.



Expand All @@ -57,7 +55,7 @@ These interfaces will be atractive to the user and easy to use, as well as fast-
==== White Box Microservices

The components of the webApp are the microservices, apart from the interfaces, which will have all the logic of the game and are the ones
who will interact with the external services (Wikidata). There will be one microservice for each one of the responsibilities of the game.
who will interact with the external services (Wikidata, mongodb). There will be one microservice for each one of the responsibilities of the game.
These microservices will need to be fast in getting all the data they need and they need to communicate with the interfaces to be able to show
the user all they need to know to play the game.

Expand Down

0 comments on commit 00bf869

Please sign in to comment.