From 48dcc95b5e3ab2489de2430563125384f63d810b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Fern=C3=A1ndez=20Noriega?= Date: Mon, 8 Apr 2024 07:20:39 +0200 Subject: [PATCH] Minor syntax mistakes corrected to build documentation correctly --- docs/src/01_introduction_and_goals.adoc | 1 + docs/src/04_solution_strategy.adoc | 2 ++ docs/src/06_runtime_view.adoc | 4 ++-- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/src/01_introduction_and_goals.adoc b/docs/src/01_introduction_and_goals.adoc index 7717116..d1c8833 100644 --- a/docs/src/01_introduction_and_goals.adoc +++ b/docs/src/01_introduction_and_goals.adoc @@ -44,6 +44,7 @@ See https://docs.arc42.org/section-1/[Introduction and Goals] in the arc42 docum **** The functional requirements are the following: + * The application must be accesible through the web * Users must be able to register into the system * Users must be able to see data about their past games (score, correct/wrong answers, number of questions answered...) diff --git a/docs/src/04_solution_strategy.adoc b/docs/src/04_solution_strategy.adoc index 25b0d86..d542447 100644 --- a/docs/src/04_solution_strategy.adoc +++ b/docs/src/04_solution_strategy.adoc @@ -3,6 +3,7 @@ ifndef::imagesdir[:imagesdir: ../images] [[section-solution-strategy]] == Solution Strategy The web application is based on MERN stack, a full-stack combination of technologies for developing JavaScript applications fast. + * *Node:* the JavaScript runtime environment. * *MongoDB:* chosen technology for the persistance of the system, that provides a non-relational database approach. * *Express and Node:* they make up the middle tier of the application, providing a powerful server platform. @@ -11,6 +12,7 @@ The web application is based on MERN stack, a full-stack combination of technolo Regarding the deployment of the application, the strategy chosen is a *cloud-based* system. This decision was motivated because of the nature of the project, since a web application needs to be live and accesible at any moment. The server will be an ARM *Linux VM on Oracle*, where some *dockerized microservices* will be deployed: + * users service * authentication service * questions service diff --git a/docs/src/06_runtime_view.adoc b/docs/src/06_runtime_view.adoc index 229707c..44d58d4 100644 --- a/docs/src/06_runtime_view.adoc +++ b/docs/src/06_runtime_view.adoc @@ -35,7 +35,7 @@ GW -> WEBC: Send category statistics * An overview of the runtime scenario of a game. [plantuml, "playing_diagram", png] ---- +---- actor User entity WEBC as "Web Client" entity GW as "Gateway" @@ -57,7 +57,7 @@ QU -> USERS: Update user points USERS -> DB: Modify user data QU -> GW: Send result and new question GW -> WEBC: Send result and new question ---- +---- [role="arc42help"] ****