Merge pull request #67 from Arquisoft/develop

Develop
Arquisoft · Apr 13, 2023 · dd25ce4 · dd25ce4
2 parents 6240d03 + 94ad28e
commit dd25ce4
Show file tree

Hide file tree

Showing 115 changed files with 7,517 additions and 2,945 deletions.
diff --git a/.github/workflows/lomap_es5c.yml b/.github/workflows/lomap_es5c.yml
@@ -1,9 +1,7 @@
 name: CI for LOMAP ES5C
 
-on:
-  release:
-    types: [published]
-
+on: [push, pull_request]
+
 jobs:
   unit-test-webapp:
     runs-on: ubuntu-latest
@@ -22,66 +20,7 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-  unit-test-restapi:
-    runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: restapi
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 18
-      - run: npm ci
-      - run: npm test --coverage --watchAll
-      - name: Analyze with SonarCloud
-        uses: sonarsource/sonarcloud-github-action@master
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-  e2e-tests:
-    needs: [unit-test-webapp, unit-test-restapi]
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 18
-      - run: npm --prefix webapp install
-      - run: npm --prefix restapi install
-      - run: npm --prefix webapp run build
-      - run: npm --prefix webapp run test:e2e
-  docker-push-webapp:
-    name: Push webapp Docker Image to GitHub Packages
-    runs-on: ubuntu-latest
-    needs: [e2e-tests]
-    steps:
-      - uses: actions/checkout@v3
-      - name: Publish to Registry
-        uses: elgohr/Publish-Docker-Github-Action@v5
-        env:
-          API_URI: http://${{ secrets.DEPLOY_HOST }}:5001/api
-        with:
-          name: arquisoft/lomap_es5c/webapp
-          username: ${{ github.actor }}
-          password: ${{ secrets.DOCKER_PUSH_TOKEN }}
-          registry: ghcr.io
-          workdir: webapp
-          buildargs: API_URI
-  docker-push-restapi:
-    name: Push restapi Docker Image to GitHub Packages
-    runs-on: ubuntu-latest
-    needs: [e2e-tests]
-    steps:
-      - uses: actions/checkout@v3
-      - name: Publish to Registry
-        uses: elgohr/Publish-Docker-Github-Action@v5
-        with:
-          name: arquisoft/lomap_es5c/restapi
-          username: ${{ github.actor }}
-          password: ${{ secrets.DOCKER_PUSH_TOKEN }}
-          registry: ghcr.io
-          workdir: restapi
+
   # deploy:
   #   name: Deploy over SSH
   #   runs-on: ubuntu-latest

diff --git a/README.md b/README.md
@@ -1,7 +1,12 @@
 # LoMap Es5c
+<img src="/assets/LOMAP_presentation.png" width="70%" height="70%"/>
 
-## Participant list
 
+[![CI for LOMAP ES5C](https://github.com/Arquisoft/lomap_es5c/actions/workflows/lomap_es5c.yml/badge.svg)](https://github.com/Arquisoft/lomap_es5c/actions/workflows/lomap_es5c.yml)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Arquisoft_lomap_es5c&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Arquisoft_lomap_es5c)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Arquisoft_lomap_es5c&metric=coverage)](https://sonarcloud.io/summary/new_code?id=Arquisoft_lomap_es5c)
+
+## 👨‍💻 Participant list
 [![Jony](https://img.shields.io/badge/UO283586-Jonathan%20Arias-yellow)](https://github.com/JonathanAriass)
 
 [![Edu](https://img.shields.io/badge/UO285176-Eduardo%20Blanco-blueviolet)](https://github.com/gitblanc)
@@ -12,17 +17,17 @@
 
 [![Xin](https://img.shields.io/badge/UO276967%20-Chen%20Xin%20Pan%20Wang-hotpink)](https://github.com/iimxinn)
 
-[![CI for LOMAP ES5C](https://github.com/Arquisoft/lomap_es5c/actions/workflows/lomap_es5c.yml/badge.svg)](https://github.com/Arquisoft/lomap_es5c/actions/workflows/lomap_es5c.yml)
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Arquisoft_lomap_es5c&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Arquisoft_lomap_es5c)
-[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Arquisoft_lomap_es5c&metric=coverage)](https://sonarcloud.io/summary/new_code?id=Arquisoft_lomap_es5c)
-
-<p float="left">
-<img src="https://blog.wildix.com/wp-content/uploads/2020/06/react-logo.jpg" height="100">
-<img src="https://miro.medium.com/max/1200/0*RbmfNyhuBb8G3LWh.png" height="100">
-<img src="https://miro.medium.com/max/365/1*Jr3NFSKTfQWRUyjblBSKeg.png" height="100">
-</p>
-
-This project is a basic example of website using **React** with **Typescript** and an endpoint using **NodeJS** with **express**.
+---
+## 💻 Technologies used
+
+![](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)
+![](https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=F7DF1E)
+![](https://img.shields.io/badge/CSS3-1572B6?style=for-the-badge&logo=css3&logoColor=white)
+![](https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white)
+![](https://img.shields.io/badge/Material--UI-0081CB?style=for-the-badge&logo=material-ui&logoColor=white)
+<img src="https://user-images.githubusercontent.com/87705461/217768979-69ceaa1b-27c4-48da-955d-40813377bb15.png" alt="solid" width="25"/>
+![](https://img.shields.io/badge/Amazon_AWS-232F3E?style=for-the-badge&logo=amazon-aws&logoColor=white)
+![](https://img.shields.io/badge/MongoDB-4EA94B?style=for-the-badge&logo=mongodb&logoColor=white)
 
 ## Quick start guide
 

diff --git a/assets/LOMAP_presentation.png b/assets/LOMAP_presentation.png
diff --git a/assets/frog.gif b/assets/frog.gif
diff --git a/docs/01_introduction_and_goals.adoc b/docs/01_introduction_and_goals.adoc
@@ -111,6 +111,7 @@ Table with role names, person names, and their expectations with respect to the
 |Jonathan Arias Busto|uo283586@uniovi.es| Learn new skills and learn how to work as a team on big projects
 |Laura Cordero Castrillo|uo275955@uniovi.es| Build a useful app and learn new technologies
 |Fernando José González Sierra|uo277938@uniovi.es|Learn new frontend skills and build a nice app
+|Chen Xin Pan Wang|uo276967@uniovi.es|Learn some new technologies and work in a good team
 |Cristian Augusto|augustocristian@uniovi.es|A full functional and decentralized app
 |Irene Cid|cidirene@uniovi.es|A full functional and decentralized app
 |===
diff --git a/docs/03_system_scope_and_context.adoc b/docs/03_system_scope_and_context.adoc
@@ -76,6 +76,7 @@ image::Technical.png[]
 |Docker| Used for the system deployment
 |AWS| Used for the system deployment
 |MongoDB| Used for store some aditional data.
+|Bootstrap| Simplifies the use of CSS and HTML, using the HTLM5 standards.
 |=======================
 
 We use OpenStreet Maps as the main API for the project to visualize the maps.
diff --git a/docs/04_solution_strategy.adoc b/docs/04_solution_strategy.adoc
@@ -42,7 +42,10 @@ We have chosen to use the next technologies on the app:
 
 * **Github**: is a version management system where all the code will be stored, structured and modified.
 
+* **Bootstrap**: is a framework that provides a collection of tools to simplify the use of html and css in the application.
+
 === Why this technologies?
 * React, CSS, Javascript and NodeJS were chosen to reach a good level of usability and accesibility.
 * MongoDB, SOLID, docker and some libraries of NodeJS will provide the privacy, integrity and security of the web app.
 * Github was chosen for version control and organization and communication between the team.
+* Bootstrap was chosen becouse the facilities it provides and to have a nice, clean and responsive view to the web app.
diff --git a/docs/09_design_decisions.adoc b/docs/09_design_decisions.adoc
@@ -31,6 +31,6 @@ Various options:
 |Data Base| We will use MongoDB to store some information.| MonboDB works good with NodeJS. | It is a new technology for the team, so we have to learn.
 |OpenStreetMaps API| We will use the API to create the map. | It's free, not like the Google Maps API.| It's the first time using it, we'll have to adapt.
 |Docker+AWS| We use them to deploy the application.| It's free and it provides a very fast deployment. | The general cloud computing issues as backup protection.
-|CSS| We use it to add a nice look to the application.| It's a well known stylesheet languaje for the team. | Different browsers work different, we have to take care of it.|
+|CSS+Bootstrap| We use it to add a nice look to the application.| It's a well known stylesheet languaje for the team. | Different browsers work different, we have to take care of it.|
 |=======================
 
diff --git a/docs/11_technical_risks.adoc b/docs/11_technical_risks.adoc
@@ -32,6 +32,4 @@ This is a list of identified technical risks, ordered by priority (1 is the high
 * In order to avoid this risk or minimize its damage, we will have to be open to the other team members, always consider their ideas and help each other if someone doesn't understand something.
 
 === Technical Debt
-This is a list of identified technical debts, ordered by priority (1 is the highest priority).
-
-1. The frontend application unsolved package vulnerabilities, forcing us to use the '--force' when we need to install.
+This is a list of identified technical debts, ordered by priority (1 is the highest priority).
diff --git a/docs/12_glossary.adoc b/docs/12_glossary.adoc
@@ -36,5 +36,5 @@ Potentially more columns in case you need translations.
 |	MVC	|	Pattern in software design commonly used to implement user interfaces, data, and controlling logic. It emphasizes a separation between the software's business logic and display.
 |	POD	|	Pods are like secure personal web servers for data. When data is stored in someone's Pod, they control which people and applications can access it.
 |	SOLID	|	SOLID is an acronym for the first five object-oriented design principleS. These principles establish practices that lend to developing software with considerations for maintaining and extending as the project grows.
-
+|   Bootstrap   |  A multiplatform library, open source toolbox to design web applications.
 |===
diff --git a/docs/README.md b/docs/README.md
@@ -32,4 +32,4 @@ The documentation will be generated under the `docs/build` directory.
 ### Documentation deployment
 If we want to deploy it to GitHub pages, so it is accesible via [https://arquisoft.github.io/lomap_es5c/](https://arquisoft.github.io/lomap_es5c/) we need to execute `npm run deploy`.
 
-If you check the `package.json` in this directory you can see how deploying is as easy as executing `gh-pages -d build`, which can be directly executed using `npm run deploy` in the docs directory. The `gh-pages` package is in charge of pushing the documentation generated directory (basically some htmls) to a special github branch called gh-pages. Everything pushed to this branch is accessible in the repository page. Note that we only want to push there the documentation. Also is important that the documentation build is not pushed to the other branches of the project.
+If you check the `package.json` in this directory you can see how deploying is as easy as executing `gh-pages -d build`, which can be directly executed using `npm run deploy` in the docs directory. The `gh-pages` package is in charge of pushing the documentation generated directory (basically some htmls) to a special github branch called gh-pages. Everything pushed to this branch is accessible in the repository page. Note that we only want to push there the documentation. Also is important that the documentation build is not pushed to the other branches of the project.
diff --git a/docs/README_es.md b/docs/README_es.md
@@ -34,4 +34,4 @@ La documentación se generará en el directorio `docs/build`.
 ### Despliegue Documentación
 Si queremos desplegar la documentación en GitHub pages, estará accesible en [https://arquisoft.github.io/lomap_es5c/](https://arquisoft.github.io/lomap_es5c/) necesitamos ejecutar `npm run deploy`.
 
-Si revisas el `package.json` de este directorio veras como desplegar es tan fácil como ejecutar `gh-pages -d build`, que puede hacerse ejecutando directamente `npm run deploy` en el directorio de la documentación. el paquete `gh-pages` se encarga de subir la documentación generada (básicamente archivo html) a una rama especial de github llamada gh-pages. Todo lo que se suba a esa rama es accesible en la página del repositorio. Ten en cuenta que solo queremos subir ahí la documentación. También es importante que el build de la documentación no se suba a otras ramas del proyecto.
+Si revisas el `package.json` de este directorio veras como desplegar es tan fácil como ejecutar `gh-pages -d build`, que puede hacerse ejecutando directamente `npm run deploy` en el directorio de la documentación. el paquete `gh-pages` se encarga de subir la documentación generada (básicamente archivo html) a una rama especial de github llamada gh-pages. Todo lo que se suba a esa rama es accesible en la página del repositorio. Ten en cuenta que solo queremos subir ahí la documentación. También es importante que el build de la documentación no se suba a otras ramas del proyecto.
diff --git a/docs/about-arc42.adoc b/docs/about-arc42.adoc
@@ -17,4 +17,4 @@ Template Revision: 7.0 EN (based on asciidoc), January 2017
 (C)
 We acknowledge that this document uses material from the
 arc 42 architecture template, http://www.arc42.de.
-Created by Dr. Peter Hruschka & Dr. Gernot Starke.
+Created by Dr. Peter Hruschka & Dr. Gernot Starke.
diff --git a/docs/arc42-template.adoc b/docs/arc42-template.adoc
@@ -93,4 +93,3 @@ include::src/11_technical_risks.adoc[]
 // 12. Glossary
 include::src/12_glossary.adoc[]
 
-
diff --git a/docs/images/Add places diagram.png b/docs/images/Add places diagram.png
diff --git a/docs/images/Friends list diagram.png b/docs/images/Friends list diagram.png
diff --git a/docs/images/Logo IoMap.png b/docs/images/Logo IoMap.png
diff --git a/docs/images/Map diagram.png b/docs/images/Map diagram.png
diff --git a/docs/images/Reviews diagram.png b/docs/images/Reviews diagram.png
diff --git a/docs/images/Technical.png b/docs/images/Technical.png
diff --git a/docs/images/filter map diagram.png b/docs/images/filter map diagram.png
diff --git a/docs/images/login diagram.png b/docs/images/login diagram.png
diff --git a/docs/images/register diagram.png b/docs/images/register diagram.png
diff --git a/docs/index.adoc b/docs/index.adoc
@@ -93,4 +93,4 @@ include::12_glossary.adoc[]
 
 <<<<
 // About
-include::about-arc42.adoc[]
+include::about-arc42.adoc[]