From 9e5b7d753a96ee0cefa1cb70de717438a0db3c0c Mon Sep 17 00:00:00 2001 From: AlvaroGlezC Date: Mon, 3 Jun 2024 21:20:04 +0200 Subject: [PATCH] Updates --- index.html | 34 ++++++++++++++++------------------ 1 file changed, 16 insertions(+), 18 deletions(-) diff --git a/index.html b/index.html index 64d5948..9fcb575 100644 --- a/index.html +++ b/index.html @@ -585,9 +585,6 @@

1. Introduction and Goals

SYG is the name of the application, where you can interact with the game itself, as well as with different extra functionalities of the web, such as consulting your game history, rankings, etc.

-
-

It follows the SOLID principles, guaranteeing the privacy of the client’s personal data.

-
@@ -677,7 +674,7 @@

1.2. Quality Goals

3

Security

-

The treatment of private information will be decentralized, ensuring customer privacy

+

The treatment of private information will be securized, ensuring user privacy through a login to the app

4

@@ -791,7 +788,7 @@

2.2. Technical constraints frontend

React

-

We will use the React Framework for the UI (User Interface)

+

JavaScript library for building user interfaces

TypeScrypt

@@ -803,7 +800,7 @@

2.2. Technical constraints frontend

MUI

-

is a library of user interface components for React, based on Google’s Material Design, which offers a wide range of predefined elements for building web applications

+

Is a library of user interface components for React, based on Google’s Material Design, which offers a wide range of predefined elements for building web applications

Sass

@@ -830,7 +827,7 @@

2.3. Technical constraints git/deploy<

GitHub

-

We will use GitHub to deploy the project and all the files related with it

+

Deploy the project and all the files related with it

@@ -872,7 +869,7 @@

2.5. Conventions

Aesthetic and ease of use

-

The UI (User Interface) has to be aesthetic and easy to use. Both of them are very important criteria in our application, so all of our decisions need to have this in mind

+

The UI (User Interface) has to be aesthetic and easy to use. Both of them are very important criteria in our application

Documentation

@@ -880,7 +877,11 @@

2.5. Conventions

TypeScript

-

We will use TypeScript/JavaScript naming conventions

+

TypeScript/JavaScript naming conventions

+ + +

Backend

+

The API will use all necessary code design conventions, without losing simplicity and maintainability in the code, such as design patterns.

@@ -936,9 +937,6 @@

3.1. Technical Context

Our application is divided into frontend (React with node.js), backend (restapi with maven), testing (e2e, integration and unit Test). In backend, we use a hexagonal architecture improving the security and performance of the website, with which we get an immutable domain for the rest of the components that can attach to this domain. The system is made with the idea of microservices in mind, using docker containers, for the deployment of these microservices used both in the project and in testing (e2e and integration test), for the unit tests Mock is used. On the frontend, the React framework is used along with typescript and MUI, together with its own styles in Sass. The database is using MySQL, although with an immutable domain it could support other databases.

-
-

Technical Context diagram

-
@@ -999,7 +997,7 @@

4. Solution Strategy

4.1. Technology decisions

-

The technologies we have decided to use for the development of the app are:

+

Technologies to be used for the development of the app are:

    @@ -1233,11 +1231,11 @@

    7.1. Infrastructure Level 1

    • Motivation: -This diagram helps to point out the different components that we will have to use and their dependencies. It helps us to visualise the deployment path for the system to work.

      +This diagram helps to point out the different components we will need to use and their dependencies. It helps to visualise the deployment path for the system to work.

    • Quality and/or Performance Features: -To improve the quality of the system we have used the best technologies at our disposal, trying to minimise waiting times for user requests.

      +In order to improve the quality of the system, the latest and most advanced technologies will be used, trying to minimise waiting times for user requests.

    • Mapping of Building Blocks to Infrastructure: @@ -1256,7 +1254,7 @@

      7.2. Infrastructure Level 2

    • Quality and/or Performance Features: -As we can see in the following image, we are going to use Azure to deploy the application, serving as a remote server. We will also use Docker to launch each part of the system.

      +As we can see in the following image, Azure will be used to deploy the application, serving as a remote server. We will also use Docker to launch each part of the system.

    • Mapping of Building Blocks to Infrastructure: @@ -1549,7 +1547,7 @@

      10.1. Quality Scenarios

- + @@ -1609,7 +1607,7 @@

11.1. Technology Risks

- +

Performance

the app is able to respond quickly to different user requests

The app is able to respond quickly to different user requests

High

High

Grafana and Prometeus

We have never used these tools to monitor a project and we need to adapt to them. A bit like with azure

I have never used these tools to monitor a project and we need to adapt to them. A bit like with azure