Skip to content

Commit

Permalink
Merge branch 'develop' into pruebas_cucumber
Browse files Browse the repository at this point in the history
  • Loading branch information
Koquda committed Apr 30, 2023
2 parents 41e6711 + 9043212 commit 87a4fdc
Show file tree
Hide file tree
Showing 62 changed files with 1,374 additions and 51,934 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/lomap_es6c.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on:
release:
types: [published]
pull_request:
branches: [master]
branches: [master, develop]

jobs:
unit-test-webapp:
Expand All @@ -20,7 +20,7 @@ jobs:
- run: npm ci
- run: npm test --coverage --watchAll
- name: Analyze with SonarCloud
uses: sonarsource/sonarcloud-github-action@master
uses: sonarsource/sonarcloud-github-action@v1.8
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
Expand All @@ -37,7 +37,7 @@ jobs:
- run: npm ci
- run: npm test --coverage --watchAll
- name: Analyze with SonarCloud
uses: sonarsource/sonarcloud-github-action@master
uses: sonarsource/sonarcloud-github-action@v1.8
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
Expand Down
2 changes: 1 addition & 1 deletion docs/01_introduction_and_goals.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Table with role names, person names, and their expectations with respect to the
|===
|Role/Name|Contact|Expectations
| Equipo de desarrollo | HappySw | Desarrollar la aplicación según las especificaciones y requisitos del cliente
| Cliente | Ayuntamiento de Bruselas | Se espera que entregue una especificación de los requisitos y que siga el projecto para comprobar que se ajusta a los requisitos especificados
| Cliente | Ayuntamiento de Bruselas | Se espera que entregue una especificación de los requisitos y que siga el projecto para comprobar que se ajusta a los requisitos especificados. También se espera que pueda añadir sitios, comentarios, valoraciones, etc a la aplicación
| Cliente Potencial | Ayuntamientos de otras ciudades | No se espera que participe en el proyecto, pero se espera que pueda contratar el servicio para tener la aplicación en el futuro para su ciudad
| Usuario Final | Ciudadanos | Que pueda utilizar la aplicación sin problemas con una esperada facilidad de uso y fluidez
|===
7 changes: 2 additions & 5 deletions docs/02_architecture_constraints.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@
|Restricción|Explicación
| _SOLID_ | _Nos permitirá almacenar los datos de los usuarios de forma segura en almacenes de datos descentralizados llamados Pods. Los usuarios podrán aceptar, o bien rechazar, el acceso a sus datos por parte de otros usuarios._
| _Github_ | _En él tendremos un repositorio remoto para el desarrollo del proyecto. Nos facilitará la gestión de las distintas tareas pendientes por realizar, así como llevar un control de versiones._
| _React_ | _La utilizaremos para la construcción del front-end del sistema._
| _Node.js_ | _Lo utilizaremos para la construcción del back-end del sistema._
| _Arc42_ | _Seguiremos la plantilla Arc42 para la realización de la documentación del sistema._
|===

=== Organización
Expand All @@ -26,11 +25,9 @@
=== Normas
[options="header",cols="1,2"]
|===
|Restricción|Explicación
|Tecnología|Explicación
| _Lenguaje_ | _Todos los integrantes del grupo nos esforzaremos en aprender a utilizar de forma adecuada los diferentes lenguajes de programación citados a utilizar en el desarrollo del sistema._
| _Código_ | _Nos esforzaremos en mantener el código limpio y bien documentado, de modo que este sea más fácil de entender y mantener._
| _Arc42_ | _Como decisión impuesta seguiremos la plantilla Arc42 para la realización de la documentación del sistema._
| _Accesibilidad_ | _El sistema debe ser usable y accesible por cualquier usuario._
| _Protección de datos_ | _Debemos tener especial cuidado en el trato de los datos sensibles de los usuarios de nuestra aplicación._
| _SOLID_ | _Como decisión impuesta seguiremos las especificaciones Solid._
|===
46 changes: 20 additions & 26 deletions docs/05_building_block_view.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,52 +6,46 @@
Motivación::
A continuación, se pretende dar una visión general del sistema por medio de una abstracción de su estructura de modo que sea fácil de entender.

Building Blocks contenidos::
En el sistema interactúan dos tipos de actores:
- Usario: Utiliza el sistema (mediante el uso de la vista 'usuario' del sistema). Es el propietario de su POD.
- Administrador: Se encarga de administrar el sistema (mediante el uso de la vista 'administrador' del sistema).

Caja blanca actores del sistema::
[options="header",cols="1,2"]
|===
|Nombre|Responsabilidad
| _Usuario_ | _Utiliza el sistema (mediante el uso de la vista 'usuario' del sistema). Es el propietario de su POD._
| _Administrador_ | _Se encarga de administrar el sistema (mediante el uso de la vista 'administrador' del sistema)._
|===

=== Level 1
Caja blanca LoMap::
Caja blanca de LoMap::
[options="header",cols="1,2"]
|===
|Nombre|Responsabilidad
| _Back-end_ | _Contiene todo lo necesario para que la aplicación funcione adecuadamante. Se comunica con el Front-end para obtener aquellos datos proporcionados por el usuario, los procesa y realiza las operaciones pertinentes._
| _Front-end_ | _Contiene las interfaces de usuario. Permite que los usuarios finales de la aplicación puedan interactuar con esta. Además, a través de ella se recopilan datos del usuario._
| _POD_ | _Almacén de datos para cada usuario de la aplicación. Es externo al sistema._
| _Cliente_ | _Cliente final de la aplicación._
| _LoMap_ | _El sistema como tal. Los clientes interactúan con el._
| _POD_ | _Almacén de datos para cada cliente de la aplicación. El cliente posee el control absoluto de sus datos privados. Es externo al sistema._
| _OpenStreetMaps API_ | _Nos permite generar los mapas en la aplicación._
|===

=== Level 2
Caja blanca Back-end::
LoMap::
En este apartado profundizamos en el sistema LoMap.
[options="header",cols="1,2"]
|===
|Nombre|Responsabilidad
| _..._ | _..._
| _Back-end_ | _Contiene todo lo necesario para que la aplicación funcione adecuadamante. Se comunica con el Front-end para obtener aquellos datos proporcionados por el cliente, los procesa y realiza las operaciones comentadas más adelante._
| _Front-end_ | _Contiene las interfaces de usuario. Permite que los clientes finales de la aplicación puedan interactuar con esta. Además, a través de ella se recopilan datos del cliente._
|===

=== Level 3
Caja blanca Front-end::
Back-end::
En este apartado profundizamos en el backend (restapi) del sistema, esta se comunica con la bbdd y los pods de Solid.
[options="header",cols="1,2"]
|===
|Nombre|Responsabilidad
| _MainMenu_ | _Página inicial (menú principal) de la aplicación. En esta se muestran enlaces a otras páginas de la app para redireccionar al usuario._
| _WelcomePage_ | _Página de bienvenida a la aplicación. En esta se muestra el mapa y enlaces a otras páginas de la app para redireccionar al usuario._
| _LoginPage_ | _Permite al usuario de la aplicación iniciar sesión con su usuario y contraseña._
| _SignupPage_ | _Permite a un nuevo usuario de la aplicación registrarse con su usuario, email y contraseña._
| _Api_ | _Se comunica con la base de datos y los pods._
|===

=== Level 4
Caja blanca POD::
Front-end::
En este apartado profundizamos en el frontend (webapp) del sistema, con la cual el cliente de la aplicación interactúa.
[options="header",cols="1,2"]
|===
|Nombre|Responsabilidad
| _..._ | _..._
| _Página inicial_ | _Menú principal de la aplicación. En esta se muestran enlaces a otras páginas de la app para redireccionar al cliente {Inicio, Documentación, Sobre Nosotros y Perfil}._
| _Página de bienvenida_ | _En esta se muestra el mapa del cliente, en el caso de que tenga la sesión iniciada, o información de la aplicación y un enlace a Solid. Además, en el primer caso el usuario puede crear en la vista nuevos marcados y comentarios._
| _Documentación_ | _Muestra la documentación de la app._
| _Sobre Nosotros_ | _Página en la que le hacemos una breve presentación al cliente de la app._
| _Inicio de sesión_ | _Permite al cliente de la aplicación dirigirse a la página de Inrupt para iniciar sesión o registrarse._
| _Perfil_ | _Página del cliente con sesión iniciada donde puede ver parte de sus datos almacenados en el pod y tiene acceso a su mapa, sus marcadores y a la vista para buscar amigos._
|===
4 changes: 3 additions & 1 deletion docs/09_design_decisions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ Various options:

| Uso de Pods | Se utilizarán los Pods para almacenar la información de cada cliente | Seguridad de datos, escalabilidad y alta disponibilidad | Curva de aprendizaje, SetUp complejo

|Base de datos|Usaremos MongoDB para tener una base de datos central para la aplicación | Escalabilidad, flexibilidad y fácil integración | No tiene esquema de datos, pueden existir datos duplicados y no soporta el uso de JOIN
|React|Usaremos Reac como framework para realizar el frontend | Alta eficiencia, uso de componentes reutilizables y fácil integración | Curva de aprendizaje y no es un framework completo

|TypeScript|Usaremos TypeScript para el desarrollo del frontend | Mejor seguridad debido al tipado estático, mejor calidad de código y amplia compatibilidad | Curva de aprendizaje, mas complejidad en algunos casos y tiempo de desarrollo adicional

|OpenStreetMaps API|Para la generación de mapas utilizaremos esta API|Es gratuita|Curva de aprendizaje
|===
2 changes: 1 addition & 1 deletion docs/10_quality_scenarios.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Tabular or free form text.
|Accesibilidad|La aplicación se adapta a la vista de los diferentes dispositivos| Alta
|Usabilidad|El usuario puede funcionar con la aplicación de manera intuitiva y sencilla| Alta
|Privacidad|Solamente el usuario puede acceder a sus datos personales ya que se almacenan en su Pod personal| Alta
|Integridad|Los datos guardados siempre serán correctos| Media
|Integridad|Los datos guardados siempre se manejarán siguiendo las medidas necesarias para que se mantengan completos, precisos y consistentes en todo momento| Media
|Seguridad|La información sensible de los usuarios será protegida, además, se necesita autorización para acceder a ubicación y demás servicios| Alta
|Mantenibilidad|Que sea susceptible y flexible a cambios| Media-Alta
|Descentralización|Los datos de los usuarios no estan en un servidor central, esta fuertemente relacionado con la privacidad| Media
Expand Down
1 change: 0 additions & 1 deletion restapi/.dockerignore

This file was deleted.

7 changes: 0 additions & 7 deletions restapi/Dockerfile

This file was deleted.

49 changes: 0 additions & 49 deletions restapi/README.md

This file was deleted.

51 changes: 0 additions & 51 deletions restapi/README_es.md

This file was deleted.

11 changes: 0 additions & 11 deletions restapi/monitoring/grafana/provisioning/dashboards/dashboard.yml

This file was deleted.

Loading

0 comments on commit 87a4fdc

Please sign in to comment.