From 574fd89da55c58259738c45e4ef196179cdc5259 Mon Sep 17 00:00:00 2001 From: Pedro Limeres <113518495+plg22@users.noreply.github.com> Date: Mon, 8 May 2023 01:19:26 +0200 Subject: [PATCH 1/4] Update README.md --- README.md | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index ccb4548..b52af9b 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,26 @@ [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Arquisoft_lomap_en2b&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Arquisoft_lomap_en2b) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Arquisoft_lomap_en2b&metric=coverage)](https://sonarcloud.io/summary/new_code?id=Arquisoft_lomap_en2b) +## Introduction to Lomap + +This is an application done by a team of UniOvi students, simulating a project done by a belgian software company, for the Council of Brussels. +It is an application where the users can login with their Solid accounts and share their favourite landmarks and places all around the globe with their friends. In the application you will be able to see your friends' landmarks, and you can create landmarks on your favourite places in order to let people see what you enjoy the most about the city of Brussels and also from the whole world. + +This is a website done while we learnt some technologies like **React**, **Typescript** or an endpoint using **NodeJS** with **express**. + +## Team members + +Andres Cadenas Blanco UO282276@uniovi.es +Pedro Limeres Granado uo282763@uniovi.es +Diego Villanueva Berros UO283615@uniovi.es +Jorge Joaquín Gancedo Fernández UO282161@uniovi.es + +

+ + + +

+ ## Sections * [Quickstart guide](#quickstart-guide) @@ -91,19 +111,3 @@ will mock the implementation of the addUser function. Instead of calling the API The `Dockerfile` for the webapp is pretty simple. Just copy the app, install the dependencies, build the production version an then run a basic webserver to launch it. In order to run the app, we need a server. `npm start` is not good for production so we are going to use [Express](https://expressjs.com/es/). Check [server.js](webapp/server.ts) in the webapp to understand the configuration. As we will run it in port 3000 (in localhost), we have to bind this port with the port in our local machine. - -## Team members - -Andres Cadenas Blanco UO282276@uniovi.es -Pedro Limeres Granado uo282763@uniovi.es -Diego Villanueva Berros UO283615@uniovi.es -Jorge Joaquín Gancedo Fernández UO282161@uniovi.es - -

- - - -

- - -This project is a basic example of website using **React** with **Typescript** and an endpoint using **NodeJS** with **express**. From a0b5d26078982c0b921e793e90e5344d9122a5e5 Mon Sep 17 00:00:00 2001 From: Pedro Limeres <113518495+plg22@users.noreply.github.com> Date: Mon, 8 May 2023 01:20:40 +0200 Subject: [PATCH 2/4] Update README.md --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b52af9b..b4cbd1b 100644 --- a/README.md +++ b/README.md @@ -9,14 +9,7 @@ This is an application done by a team of UniOvi students, simulating a project done by a belgian software company, for the Council of Brussels. It is an application where the users can login with their Solid accounts and share their favourite landmarks and places all around the globe with their friends. In the application you will be able to see your friends' landmarks, and you can create landmarks on your favourite places in order to let people see what you enjoy the most about the city of Brussels and also from the whole world. -This is a website done while we learnt some technologies like **React**, **Typescript** or an endpoint using **NodeJS** with **express**. - -## Team members - -Andres Cadenas Blanco UO282276@uniovi.es -Pedro Limeres Granado uo282763@uniovi.es -Diego Villanueva Berros UO283615@uniovi.es -Jorge Joaquín Gancedo Fernández UO282161@uniovi.es +This is a website done while we learnt some technologies like **React**, **Typescript** or an endpoint using **NodeJS** with **express**.

@@ -24,6 +17,13 @@ Jorge Joaquín Gancedo Fernández UO282161@uniovi.es

+## Team members + +Andres Cadenas Blanco UO282276@uniovi.es +Pedro Limeres Granado uo282763@uniovi.es +Diego Villanueva Berros UO283615@uniovi.es +Jorge Joaquín Gancedo Fernández UO282161@uniovi.es + ## Sections * [Quickstart guide](#quickstart-guide) From 849e6c921931c38ebb051d171a5e27a65f0a984a Mon Sep 17 00:00:00 2001 From: Pedro Limeres <113518495+plg22@users.noreply.github.com> Date: Mon, 8 May 2023 01:32:05 +0200 Subject: [PATCH 3/4] Update README.md --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b4cbd1b..256afe9 100644 --- a/README.md +++ b/README.md @@ -99,12 +99,20 @@ This runs the application in local, take into account you must have nodejs insta #### Unit tests Basically these tests make sure that each component work isolated. It is important to check that they render properly. These tests are done using jest and you can execute them with `npm run test`. A code coverage analysis is generated every time we run the tests. If properly configured, this can be exploited by tools like [SonarCloud](https://sonarcloud.io/) to create reports of code coverage. -Some tests needs to mock some parts of the application. For instance, the `EmailForm.tsx` component uses the api for adding a user. In the unitary tests we should mock these calls to make more robusts tests. You can check the file [EmailForm.test.tsx](src/components/EmailForm.test.tsx) to learn how this is done. -For instance: -```javascript -jest.spyOn(api,'addUser').mockImplementation((user:User):Promise => Promise.resolve(false)) +These tests have been done both on the webapp and on the restapi. + +#### e2e tests + +These type of tests make sure that the navigation on the web page is as expected. They are done using cucumber, and they are run via an automatic web browser that executes the orders we want, and compares the results it gets with the ones we want to get. +```console +cd restapi +npm i +npm run test:e2e ``` -will mock the implementation of the addUser function. Instead of calling the API, we just return false simulating that the webservice has failed to add a new user. + +#### Load Testing + +These type of tests, we external to the code, and they measured how the web application worked facing some high trafic of users, we tried to simulate different scenarios and also we tried with different number o users. We used the tool Gatling for making these tests. ### Docker image for the web app From a5fe1830563daa32f28e1733a4af4f569f779b4d Mon Sep 17 00:00:00 2001 From: Pedro Limeres <113518495+plg22@users.noreply.github.com> Date: Mon, 8 May 2023 01:34:06 +0200 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 256afe9..5e99c1f 100644 --- a/README.md +++ b/README.md @@ -94,7 +94,7 @@ npm run dev This runs the application in local, take into account you must have nodejs installed in the system. To access the webpage access in a browser write: localhost:3000 -### Testing the Webapp +### Testing the Webapp and the Restapi #### Unit tests