From 942a0a4c1222aab784d90336386a0dba86e42f59 Mon Sep 17 00:00:00 2001 From: UO277490 Date: Fri, 14 Apr 2023 09:05:54 +0200 Subject: [PATCH 1/8] Act --- docs/01_introduction_and_goals.adoc | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/01_introduction_and_goals.adoc b/docs/01_introduction_and_goals.adoc index 8fb5686..c60a161 100644 --- a/docs/01_introduction_and_goals.adoc +++ b/docs/01_introduction_and_goals.adoc @@ -1,14 +1,12 @@ [[section-introduction-and-goals]] == Introduction and Goals -[role="arc42help"] La petición del ayuntamiento de la ciudad de Bruselas es una aplicación que permita a sus ciudadanos tener un mapa donde puedan colocar marcadores en distintos sitios. Actualmente solo permite marcar sitios con diferentes tipos de marcadores dependiendo del lugar, los lugares posibles serán bares, restaurantes, monumentos, paisajes o tiendas. Los ciudadanos podrán crear sus propios mapas personalizados y compartirlos con sus amigos. === Requirements Overview -[role="arc42help"] ==== Requisitos de alto nivel: * La aplicación permitirá a los usuarios visualizar un mapa donde estos podrán añadir diferentes marcadores. * Permitirá añadir diferentes tipos de marcadores dependiendo de si este se trata de un restaurante, un bar, un monumento, un paisaje o una tienda. From 6f03f308d48915ab5c5a8e1b4dcaec6015ad0d08 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Teresa=20Fern=C3=A1ndez=20Coro?= <79691310+teresafcoro@users.noreply.github.com> Date: Fri, 14 Apr 2023 09:44:53 +0200 Subject: [PATCH 2/8] =?UTF-8?q?Update=20documentaci=C3=B3n?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/05_building_block_view.adoc | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/05_building_block_view.adoc b/docs/05_building_block_view.adoc index e6c761d..f175fdb 100644 --- a/docs/05_building_block_view.adoc +++ b/docs/05_building_block_view.adoc @@ -24,7 +24,7 @@ Caja blanca 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._ +| _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 comentadas más adelante._ | _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._ |=== @@ -34,7 +34,7 @@ Caja blanca Back-end:: [options="header",cols="1,2"] |=== |Nombre|Responsabilidad -| _..._ | _..._ +| _Api_ | _Se comunica con la base de datos y los pods._ |=== === Level 3 @@ -42,10 +42,10 @@ Caja blanca Front-end:: [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._ +| _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 {Inicio, Documentación, Sobre Nosotros y Perfil}._ +| _WelcomePage_ | _Página de bienvenida a la aplicación. En esta se muestra el mapa del usuario, en el case de que tenga la sesión iniciada, o información de la app y un enlace a Solid._ +| _LoginPage_ | _Permite al usuario de la aplicación dirigirse a la página de Inrupt para iniciar sesión, o registrarse._ +| _UserPage_ | _Página del usuario con sesión iniciada dónde puede ver sus datos almacenados por la app._ |=== === Level 4 From 1f45a319a10838c3db5167e186e11b48c3e88db5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Teresa=20Fern=C3=A1ndez=20Coro?= <79691310+teresafcoro@users.noreply.github.com> Date: Fri, 14 Apr 2023 10:35:38 +0200 Subject: [PATCH 3/8] =?UTF-8?q?M=C3=A1s=20cambios?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/05_building_block_view.adoc | 24 +++++++++--------------- 1 file changed, 9 insertions(+), 15 deletions(-) diff --git a/docs/05_building_block_view.adoc b/docs/05_building_block_view.adoc index f175fdb..d762b86 100644 --- a/docs/05_building_block_view.adoc +++ b/docs/05_building_block_view.adoc @@ -24,9 +24,11 @@ Caja blanca 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 comentadas más adelante._ -| _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._ +| _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._ +| _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._ +| _Base de Datos_ | _Utilizamos MongoDB como almacén de datos central para la aplicación._ +| _OpenStreetMaps API_ | _Nos permite generar los mapas._ |=== === Level 2 @@ -42,16 +44,8 @@ Caja blanca Front-end:: [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 {Inicio, Documentación, Sobre Nosotros y Perfil}._ -| _WelcomePage_ | _Página de bienvenida a la aplicación. En esta se muestra el mapa del usuario, en el case de que tenga la sesión iniciada, o información de la app y un enlace a Solid._ -| _LoginPage_ | _Permite al usuario de la aplicación dirigirse a la página de Inrupt para iniciar sesión, o registrarse._ -| _UserPage_ | _Página del usuario con sesión iniciada dónde puede ver sus datos almacenados por la app._ -|=== - -=== Level 4 -Caja blanca POD:: -[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 cliente {Inicio, Documentación, Sobre Nosotros y Perfil}._ +| _WelcomePage_ | _Página de bienvenida a la aplicación. En esta se muestra el mapa del cliente, en el case de que tenga la sesión iniciada, o información de la aplicación y un enlace a Solid._ +| _LoginPage_ | _Permite al cliente de la aplicación dirigirse a la página de Inrupt para iniciar sesión o registrarse._ +| _UserPage_ | _Página del cliente con sesión iniciada dónde puede ver sus datos almacenados por la app._ |=== From 48d53e8baa03106a9a772bd538e1e6cf12cda724 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Teresa=20Fern=C3=A1ndez=20Coro?= <79691310+teresafcoro@users.noreply.github.com> Date: Thu, 27 Apr 2023 10:18:32 +0200 Subject: [PATCH 4/8] Nuevo update --- docs/05_building_block_view.adoc | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/05_building_block_view.adoc b/docs/05_building_block_view.adoc index d762b86..7288341 100644 --- a/docs/05_building_block_view.adoc +++ b/docs/05_building_block_view.adoc @@ -32,7 +32,7 @@ Caja blanca LoMap:: |=== === Level 2 -Caja blanca Back-end:: +Back-end:: [options="header",cols="1,2"] |=== |Nombre|Responsabilidad @@ -40,12 +40,14 @@ Caja blanca Back-end:: |=== === Level 3 -Caja blanca Front-end:: +Front-end:: [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 cliente {Inicio, Documentación, Sobre Nosotros y Perfil}._ -| _WelcomePage_ | _Página de bienvenida a la aplicación. En esta se muestra el mapa del cliente, en el case de que tenga la sesión iniciada, o información de la aplicación y un enlace a Solid._ -| _LoginPage_ | _Permite al cliente de la aplicación dirigirse a la página de Inrupt para iniciar sesión o registrarse._ -| _UserPage_ | _Página del cliente con sesión iniciada dónde puede ver sus datos almacenados por la app._ +| _Página principal_ | _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._ |=== From f0bcb64cc9dfa73a416a0013bc660d4b67944f09 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Teresa=20Fern=C3=A1ndez=20Coro?= <79691310+teresafcoro@users.noreply.github.com> Date: Fri, 28 Apr 2023 09:44:46 +0200 Subject: [PATCH 5/8] Update 02_architecture_constraints --- docs/02_architecture_constraints.adoc | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/docs/02_architecture_constraints.adoc b/docs/02_architecture_constraints.adoc index 2c9327d..3be62f8 100644 --- a/docs/02_architecture_constraints.adoc +++ b/docs/02_architecture_constraints.adoc @@ -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 @@ -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._ |=== From 87174f231d508adcbd481ef39ba7bdeba79148b8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Teresa=20Fern=C3=A1ndez=20Coro?= <79691310+teresafcoro@users.noreply.github.com> Date: Fri, 28 Apr 2023 10:01:29 +0200 Subject: [PATCH 6/8] Update 05_building_block_view --- docs/05_building_block_view.adoc | 39 ++++++++++++++++---------------- 1 file changed, 19 insertions(+), 20 deletions(-) diff --git a/docs/05_building_block_view.adoc b/docs/05_building_block_view.adoc index 7288341..6a94da8 100644 --- a/docs/05_building_block_view.adoc +++ b/docs/05_building_block_view.adoc @@ -6,45 +6,44 @@ 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:: +=== Level 1 +Caja blanca de LoMap:: [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)._ +| _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._ +| _Base de Datos_ | _Utilizamos MongoDB como almacén de datos central para la aplicación._ |=== -=== Level 1 -Caja blanca LoMap:: +=== Level 2 +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._ -| _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._ -| _Base de Datos_ | _Utilizamos MongoDB como almacén de datos central para la aplicación._ -| _OpenStreetMaps API_ | _Nos permite generar los mapas._ +| _Restapi_ | _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._ +| _Webapp_ | _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 2 -Back-end:: +=== Level 3 +Restapi:: +En este apartado profundizamos en la restapi del sistema, esta se comunica con la bbdd y los pods de Solid. [options="header",cols="1,2"] |=== |Nombre|Responsabilidad | _Api_ | _Se comunica con la base de datos y los pods._ |=== -=== Level 3 -Front-end:: +=== Level 4 +Webapp:: +En este apartado profundizamos en la webapp del sistema, con la cual el cliente de la aplicación interactúa. [options="header",cols="1,2"] |=== |Nombre|Responsabilidad -| _Página principal_ | _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 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._ From 2344d11ad8d497f1aecad5bacfb1fdc03e5a76cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Teresa=20Fern=C3=A1ndez=20Coro?= <79691310+teresafcoro@users.noreply.github.com> Date: Fri, 28 Apr 2023 10:08:10 +0200 Subject: [PATCH 7/8] Reupdate 05_building_block_view --- docs/05_building_block_view.adoc | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/05_building_block_view.adoc b/docs/05_building_block_view.adoc index 6a94da8..ef2e9da 100644 --- a/docs/05_building_block_view.adoc +++ b/docs/05_building_block_view.adoc @@ -24,13 +24,13 @@ En este apartado profundizamos en el sistema LoMap. [options="header",cols="1,2"] |=== |Nombre|Responsabilidad -| _Restapi_ | _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._ -| _Webapp_ | _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._ +| _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 -Restapi:: -En este apartado profundizamos en la restapi del sistema, esta se comunica con la bbdd y los pods de Solid. +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 @@ -38,8 +38,8 @@ En este apartado profundizamos en la restapi del sistema, esta se comunica con l |=== === Level 4 -Webapp:: -En este apartado profundizamos en la webapp del sistema, con la cual el cliente de la aplicación interactúa. +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 From 1e695b885b68f5b2fd471bd533416647be8f4ba7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Teresa=20Fern=C3=A1ndez=20Coro?= <79691310+teresafcoro@users.noreply.github.com> Date: Sun, 30 Apr 2023 11:31:53 +0200 Subject: [PATCH 8/8] Fuera bbdd --- docs/05_building_block_view.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/05_building_block_view.adoc b/docs/05_building_block_view.adoc index ef2e9da..681e4c2 100644 --- a/docs/05_building_block_view.adoc +++ b/docs/05_building_block_view.adoc @@ -15,7 +15,6 @@ Caja blanca de LoMap:: | _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._ -| _Base de Datos_ | _Utilizamos MongoDB como almacén de datos central para la aplicación._ |=== === Level 2