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.

Sign up for GitHub

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

Jump to bottom

Hot fix docu #113

Merged
merged 1 commit into from
Apr 8, 2024
Merged

Hot fix docu #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions docs/src/01_introduction_and_goals.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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...)
Expand Down
2 changes: 2 additions & 0 deletions docs/src/04_solution_strategy.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/src/06_runtime_view.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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"]
****
Expand Down