Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #50

Merged
merged 8 commits into from
Feb 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/images/level1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/level2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/level3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/src/03_system_scope_and_context.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ Regarding the information exchanged with the application, it will require having

==== Context diagram


image::context.png["Context"]

---
Expand All @@ -58,3 +59,4 @@ image::context.png["Context"]
==== Deployment diagram

image::deployment.png["Deployment"]

68 changes: 5 additions & 63 deletions docs/src/05_building_block_view.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,7 @@ ifndef::imagesdir[:imagesdir: ../images]

=== Level 1: Whitebox of the Overall System

[plantuml, "level1", png]

----
@startuml
Actor User
Component WIQ
Component Wikidata
User -right-> WIQ: interacts with
WIQ -right-> Wikidata: receives data
Wikidata -right..> WIQ
@enduml
----
image::level1.png["Level 1"]

==== Motivation

Expand All @@ -42,22 +31,9 @@ Wikidata -right..> WIQ
|===

=== Level 2
[plantuml, "level2", png]
----
Actor User
Component WIQ {
Component ui as "User Interface"
Component ms as "MicroService"
Database db as "MongoDB"
}

Component wd as "WikiData"

User -> ui: Interacts
ui -> ms: Sends requests
ms <-> db: Reads
wd -> ms: Gives data
----

image::level2.png["Level 2"]

==== Motivation

Shows how the application will work internally. The user, through the user interface, will use microservices to access the different modules with the help of the database.
Expand All @@ -81,40 +57,8 @@ Shows how the application will work internally. The user, through the user inter
|===

=== Level 3
[plantuml, "level3", png]
----
Component WIQ {

Component ms as "MicroServices" {
Component users as "Users Service"
Component question as "Question Service"
Component game as "Game Service"
Component ranking as "ranking"
Component history as "History"
Database db as "MongoDB"
}

Component ui as "User Interface"


ui --> users
ui --> game
ui --> history
ui --> ranking
image::level3.png["Level 3"]



users <-down-> db
game <-down-> db
ranking <-down-> db
history <-down-> db
}

Component wd as "Wikidata"

game --> question: generates question
question <-> wd: ask and answer the question
----
==== Motivation

Detailed structure of the system. Focused on the components of the _User Interface_ and _Data Access_.
Expand Down Expand Up @@ -146,5 +90,3 @@ Detailed structure of the system. Focused on the components of the _User Interfa


|===

[role="arc42help"]