Skip to content
This repository has been archived by the owner on Jan 27, 2024. It is now read-only.

Commit

Permalink
Merge pull request #33 from Arquisoft/Docu_0.1_Arreglos_Pedro
Browse files Browse the repository at this point in the history
Correction of mistakes Docs0.1
  • Loading branch information
UO283615 authored Feb 28, 2023
2 parents 5b2ea85 + 6838a26 commit b83f4a5
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 16 deletions.
5 changes: 2 additions & 3 deletions docs/02_architecture_constraints.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ These constraints are the base of the architecture process, and are the roots of
|===
|Constraint|Description
| Solid | _Provided by the stakeholders. A way of building decentralized social apps, it gives every user a choice about where data is stored, helping the privacy of each user._
| Facilitate user navigavility | _The app is developed using react, a javascript library used to make the interaction of the user easier, as it helps in the building of the user interface of the web app._
| Flexibility | _The map which is the base of the app is generated using the Google Maps API, for the possibility of working in any place around the world._
| Quality | _The application is developed around some quality requirements, later described in section 10._
| Github | _The development team was given a starting draft of a project in GitHub as a public repository. From then on, all the work related with this project will be tracked and uploaded in this repository._
| Time | _The application is developed in a semester during a course, that means time is limited._
|===
24 changes: 12 additions & 12 deletions docs/04_solution_strategy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,21 @@
In this section we are explaining the main decisions we took in the development of the project.
Up until now, we have made some decisions about the project, those decisions can be organized in different categories:

.*Technology decisions*
*React: JS framework that helps with the user interface of the web application.
*Map API: Used to plot the map in the application in order to allow the user to do every possible action.
. *Technology decisions:*
* React: JS framework that helps with the user interface of the web application.
* Map API: Used to plot the map in the application in order to allow the user to do every possible action.

.*Decisions on top-level decomposition*
*MVC: We are using the MVC (Model-View-Controller) pattern in order to organize the code in a clean and obvious way.
*Editor: We are all using Visual Studio Code to work on this project, it is the editor we are used to program in and it has some features that made us work using it.
*Github: The project is on a public repository as given by the professors of the subject. We are all able to work using it, and the main features of it are the pull requests in order to upload code.
. *Decisions on top-level decomposition:*
* MVC: We are using the MVC (Model-View-Controller) pattern in order to organize the code in a clean and obvious way.
* Editor: We are all using Visual Studio Code to work on this project, it is the editor we are used to program in and it has some features that made us work using it.
* Github: The project is on a public repository as given by the professors of the subject. We are all able to work using it, and the main features of it are the pull requests in order to upload code.

.*Decisions on quality goals*
*Usability: Our map application is quite easy to use for everyone, we are focusing on the ease of the user interaction and comprehension.
*Security: It is the main point of our application, as we are using solid, we are maintaining the privacy of every user who logs into LoMap.
*Response times: As much as possible, we are trying to minimize response times of the application in order to be more user friendly.
. *Decisions on quality goals:*
* Usability: Our map application is quite easy to use for everyone, we are focusing on the ease of the user interaction and comprehension.
* Security: It is the main point of our application, as we are using solid, we are maintaining the privacy of every user who logs into LoMap.
* Response times: As much as possible, we are trying to minimize response times of the application in order to be more user friendly.

*Organizational decisions*
*Organizational decisions:*
During the development of this project, everyone is the group is in constant contact with the rest of the members of the team, mainly in the weekly meeting which takes part during lab classes throughout the semester. In addition to that, we used a whatsapp group in order to consult with each other little things that could emerge during the week.
Related with the project, our main way of working with the code was through pull requests. Each one of the members did some work, in his newly created branch and when he ended his work, he committed the changes and requested a pull request in GitHub, where another person in the group should revise the changes and aprove that pull request in order to merge the changes to the main branch.
In order to do advances in the development we are using the issues in Github as well, in that way we make sure that we do everything we consider necessary.
Expand Down
3 changes: 2 additions & 1 deletion docs/09_design_decisions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
[options="header",cols="1,4"]
|===
|Decision|Why?
| Inrupt | As a constraint in the project, we said we needed to use solid pods, and inrupt is the way we are going to include it in our project. Essentially it provides a way to deal with Solid pods.
| React | Taken as a recomendation by some teachers. In addition, one of the members of the group has already worked with it in the past. It allows us to build a good user interface for the application.
| Leaflet | It is the provider we are going to use for obtaining the necessary features around the map. We studied some other different options, such as Mapbox o Google Maps API, but we needed the Api to be completely free.
| Inrupt | As a constraint in the project, we said we needed to use solid pods, and inrupt is the way we are going to include it in our project. Essentially it provides a way to deal with Solid pods.
|===

0 comments on commit b83f4a5

Please sign in to comment.