From 79667806f533fbe99ee4439b397074e6ba3caa73 Mon Sep 17 00:00:00 2001 From: AGC <158510532+AlvaroGlezC@users.noreply.github.com> Date: Mon, 3 Jun 2024 20:35:55 +0200 Subject: [PATCH] Update 02_architecture_constraints.adoc --- docs/src/02_architecture_constraints.adoc | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/src/02_architecture_constraints.adoc b/docs/src/02_architecture_constraints.adoc index d72fb58..07db5d8 100644 --- a/docs/src/02_architecture_constraints.adoc +++ b/docs/src/02_architecture_constraints.adoc @@ -17,10 +17,10 @@ ifndef::imagesdir[:imagesdir: ../images] |=== |Constraint|Explanation -|React| We will use the React Framework for the UI (User Interface) +|React| JavaScript library for building user interfaces |TypeScrypt| TypeScript is the techonology used for the backend. Based on JavaScript is quite similar |Node.js| Based on JavaScript, is a backend technology wich allows us to execute our code -|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 +|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 |Sass| It is a CSS preprocessor that extends its functionality by allowing the use of variables, rule nesting, mixins and other features |=== @@ -29,7 +29,7 @@ ifndef::imagesdir[:imagesdir: ../images] |=== |Constraint|Explanation |Docker| The application will be running in a Docker Host -|GitHub| We will use GitHub to deploy the project and all the files related with it +|GitHub| Deploy the project and all the files related with it |=== === Organizational and political constraints @@ -44,7 +44,8 @@ ifndef::imagesdir[:imagesdir: ../images] |=== |Constraint|Explanation -|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 +|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 |Documentation|We will use Arc42 template to develop documentation -|TypeScript|We will use TypeScript/JavaScript naming conventions +|TypeScript|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. |===