Skip to content

Commit

Permalink
5 Block View Initial
Browse files Browse the repository at this point in the history
  • Loading branch information
Alberto-Guerra committed Feb 12, 2024
1 parent 7cf2430 commit ca18f29
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 5 deletions.
42 changes: 37 additions & 5 deletions docs/src/05_building_block_view.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -63,18 +63,50 @@ In the best case you will get away with examples or simple signatures.
****

_**<Overview Diagram>**_
[plantuml, format="png"]
----
@startuml
' Define custom style for components
skinparam componentStyle uml2
' Define components as rectangles without default stereotypes
rectangle Frontend
rectangle "User Management" as UserManagement
rectangle "Question Generation" as QuestionGeneration
cloud "Wikidata API" as WikidataAPI
' Define connections
Frontend --> UserManagement
Frontend --> QuestionGeneration
QuestionGeneration --> WikidataAPI
@enduml
----

Motivation::

_<text explanation>_
Motivation::

The reasoning behind this separation is to achieve a modular architecture with clear separation of concerns.
It also allows to expose the user management and the question generation as APIs.

Contained Building Blocks::
_<Description of contained building block (black boxes)>_

[cols="1,2" options="header"]
|===
| **Name** | **Responsibility**
| Frontend | Represents the user interface and manages the quiz logic of the application.
| User Management | Handles everything related to user accounts.
| Question Generator | Generates questions from Wikidata data and sends them to the frontend.
|===

Important Interfaces::
_<Description of important interfaces>_

[cols="1,2" options="header"]
|===
| **Name** | **Description**
| Frontend <-> User Management | This interface defines how the frontend communicates with the User Management Service to log in, retrieve user data, or perform actions requiring authorization.
| Question Generator <-> Frontend | This interface defines how the Question Generator Service delivers processed questions to the frontend for display.
|===


[role="arc42help"]
****
Expand Down
6 changes: 6 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit ca18f29

Please sign in to comment.