From ee5aaa5dae6cf8fc0ba9fd78c90e74fadab99e4c Mon Sep 17 00:00:00 2001 From: Saul Date: Fri, 28 Feb 2025 18:56:34 +0100 Subject: [PATCH] Changed Technical Context diagram from 3D to 2D for better comprehension. --- docs/src/03_context_and_scope.adoc | 31 +++++++++++++----------------- 1 file changed, 13 insertions(+), 18 deletions(-) diff --git a/docs/src/03_context_and_scope.adoc b/docs/src/03_context_and_scope.adoc index a7e45d57..f4233915 100644 --- a/docs/src/03_context_and_scope.adoc +++ b/docs/src/03_context_and_scope.adoc @@ -62,27 +62,22 @@ The technical interfaces and communication channels for the WIChat application a - **Database**: **MongoDB** stores user data, including historical performance and game statistics. - **LLM Integration**: **Empathy API** is used for generating hints. -// PlantUML diagram: Deployment View +// PlantUML diagram: Deployment Diagram [plantuml,"Deployment Diagram",png] ---- -node "User's Web Browser" as Browser { - component "React Frontend" as React -} - -node "Application Server" as Server { - component "Node.js + Express" as Node - database "MongoDB" as MongoDB -} - -cloud "External APIs" as APIs { - component "Wikidata" as Wikidata - component "Empathy API" as Empathy -} +actor User -Browser --> Server : HTTP/HTTPS\n(API calls) -Server --> Wikidata : MediaWiki Action API\n(HTTP/HTTPS) -Server --> Empathy : REST API\n(HTTP/HTTPS) -Server --> MongoDB : Database operations +rectangle "React Frontend\n(HTTP/HTTPS)" as React +rectangle "Node.js + Express\n(Backend)" as Node +cloud "Wikidata\n(MediaWiki Action API)" as Wikidata +cloud "Empathy API\n(REST API)" as Empathy +database "MongoDB\n(Database)" as MongoDB + +User <--> React : Uses\nHTTP/HTTPS +React <--> Node : API calls\n(HTTP/HTTPS) +Node <--> Wikidata : Fetches data\n(HTTP/HTTPS) +Node <--> Empathy : Retrieves hints\n(HTTP/HTTPS) +Node <--> MongoDB : Reads/Writes\n(Database operations) ---- //#caption: Deployment Diagram