diff --git a/docs/images/level1.png b/docs/images/level1.png new file mode 100644 index 00000000..a4d4749d Binary files /dev/null and b/docs/images/level1.png differ diff --git a/docs/images/level2.png b/docs/images/level2.png new file mode 100644 index 00000000..2e85a839 Binary files /dev/null and b/docs/images/level2.png differ diff --git a/docs/images/level3.png b/docs/images/level3.png new file mode 100644 index 00000000..cb101be7 Binary files /dev/null and b/docs/images/level3.png differ diff --git a/docs/src/03_system_scope_and_context.adoc b/docs/src/03_system_scope_and_context.adoc index 053fb8c6..b0ca01ea 100644 --- a/docs/src/03_system_scope_and_context.adoc +++ b/docs/src/03_system_scope_and_context.adoc @@ -3,8 +3,6 @@ ifndef::imagesdir[:imagesdir: ../images] [[section-system-scope-and-context]] == System Scope and Context - -[role="arc42help"] --- === Contents @@ -17,8 +15,6 @@ The main constraints are developing the game as a web app and using Wikidata to === Business Context -[role="arc42help"] - ==== Contents * *Users:* They interact directly with the application through the user interface provided by the frontend using React, HTML, CSS, and JavaScript. @@ -48,15 +44,17 @@ Regarding the information exchanged with the application, it will require having [plantuml, "context", png] ---- +@startuml component "App" as app :User: -> [app]: Answer question -[app] -> User: Return result +[app] -> :User: Return result database DB [app] -> DB: Ask for question DB -> [app]: Return question component "WikiData" as wd [app] --> wd: Ask for keyword wd --> [app]: Return keyword +@enduml ---- --- @@ -76,13 +74,15 @@ wd --> [app]: Return keyword [plantuml, "deployment", png] ---- -node "Aplication Server" as app +@startuml +node "Application Server" as app node "DB Server" as db { -artifact "MongoDB Server" + artifact "MongoDB Server" } -node Wikidata as w -node Interface as i +node "Wikidata" as w +node "Interface" as i app - db app -- w app -- i +@enduml ---- diff --git a/docs/src/05_building_block_view.adoc b/docs/src/05_building_block_view.adoc index 466e7dfc..10e58454 100644 --- a/docs/src/05_building_block_view.adoc +++ b/docs/src/05_building_block_view.adoc @@ -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 @@ -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. @@ -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_. @@ -146,5 +90,3 @@ Detailed structure of the system. Focused on the components of the _User Interfa |=== - -[role="arc42help"]