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.

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

Documentation update #159

Merged
merged 4 commits into from
Apr 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file added docs/images/GameView.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/HomeView.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/UserView.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions docs/src/04_solution_strategy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ This page contains a short summary and explanation of the fundamental decisions
Below, all the technologies to be used in the development of the application are listed:

* *JavaScript / React:* A JavaScript library designed to facilitate the development of web applications.
* *Material UI:* Set of user interface components for web applications.
* *JavaScript / NodeJS:* An asynchronous runtime environment based on JavaScript.
* *MongoDB:* A document-oriented NoSQL database system.
* *Docker:* Used for deploying applications locally.
Expand Down Expand Up @@ -76,9 +77,8 @@ This section addresses the fundamental decisions for the project's architecture.

|===

| *Data Management* |
| *Deployment* |
| *Security* |
| *Monitoring* |
| *Deployment* | Use of Azure for application deployment
| *Security* | User access control
| *Monitoring* | Prometheus and Grafana for monitoring

|===
10 changes: 7 additions & 3 deletions docs/src/08_concepts.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
ifndef::imagesdir[:imagesdir: ../images]

[[section-concepts]]
## First Designs

### Home Page
## 1.0 Designs

### User Page
:imagesdir: ../images
image::UserView.png[User View]
---
### Home Page
image::HomeView.png[Home Menu View]
---
### Game page
Expand Down Expand Up @@ -36,4 +40,4 @@ Various expansions to the application are proposed, such as a multiplayer versio

### Data persistence and availability:
Application data is stored using MongoDB, one of the most commonly used NoSQL databases.
The application can be deployed at any time locally or in an environment such as a virtual machine.
The application can be deployed at any time locally or in an environment such as a virtual machine.