PR: 03/05/2023 - Omar - Actualización final a master

Arquisoft · May 3, 2023 · 186776e · 186776e
2 parents 70ea4b5 + 209475c
commit 186776e
Show file tree

Hide file tree

Showing 33 changed files with 661 additions and 118 deletions.
diff --git a/.github/workflows/lomap_es3a.yml b/.github/workflows/lomap_es3a.yml
@@ -47,20 +47,20 @@ jobs:
           registry: ghcr.io
           workdir: webapp
           buildargs: API_URI
-  deploy:
-    name: Deploy over SSH
-    runs-on: ubuntu-latest
-    needs: [docker-push-webapp]
-    steps:
-      - name: Deploy over SSH
-        uses: fifsky/ssh-action@master
-        with:
-          host: ${{ secrets.DEPLOY_HOST }}
-          user: ${{ secrets.DEPLOY_USER }}
-          key: ${{ secrets.DEPLOY_KEY }}
-          command: |
-            wget https://raw.githubusercontent.com/arquisoft/lomap_es3a/master/docker-compose-deploy.yml -O docker-compose.yml
-            docker-compose stop
-            docker-compose rm -f
-            docker-compose pull
-            docker-compose up -d
+#  deploy:
+#    name: Deploy over SSH
+#    runs-on: ubuntu-latest
+#    needs: [docker-push-webapp]
+#    steps:
+#      - name: Deploy over SSH
+#        uses: fifsky/ssh-action@master
+#        with:
+#          host: ${{ secrets.DEPLOY_HOST }}
+#          user: ${{ secrets.DEPLOY_USER }}
+#          key: ${{ secrets.DEPLOY_KEY }}
+#          command: |
+#            wget https://raw.githubusercontent.com/arquisoft/lomap_es3a/master/docker-compose-deploy.yml -O docker-compose.yml
+#            docker-compose stop
+#            docker-compose rm -f
+#            docker-compose pull
+#            docker-compose up -d
diff --git a/README.md b/README.md
@@ -13,97 +13,108 @@
 <h1 align="center"><img src="https://user-images.githubusercontent.com/91057639/218590043-d4243147-e5c0-4f7b-8fed-12ed8d290490.png" width="1024" height="512"></h1>
 
 <p align="center">
+   <a href="https://github.com/Arquisoft/lomap_es3a/wiki/Video-Promocional">
+      Promotional video
+   </a>
+   ·
+   <a href="https://github.com/Arquisoft/lomap_es3a/wiki/Video-Demo">
+      Demo video
+   </a>
+   ·
    <a href="https://arquisoft.github.io/lomap_es3a/">
-      Documentación
+      Docs
+   </a>
+   ·
+   <a href="https://lomapes3a.azurewebsites.net">
+      Web Access
    </a>
    ·
    <a href="https://github.com/Arquisoft/lomap_es3a/discussions">
-      Discusiones
+      Discussions
    </a>
    ·
    <a href="https://github.com/Arquisoft/lomap_es3a/wiki">
       Wiki
    </a>
    ·
    <a href="https://github.com/Arquisoft/lomap_es3a/issues/new?assignees=&labels=&template=bug_report.md&title=">
-      Reportar un bug
+      Report a bug
    </a>
    ·
    <a href="https://github.com/Arquisoft/lomap_es3a/issues/new?assignees=&labels=&template=feature_request.md&title=">
-      Solicitar una funcionalidad
+      Request a new feature
    </a>
    ·
    <a href="https://github.com/Arquisoft/lomap_es3a/projects?query=is%3Aopen">
-      Proyectos
+      Projects
    </a>
+   ·
+   <a href="https://github.com/Arquisoft/lomap_es3a/tree/master/usability_tests">
+      Usability Tests
+   </a>   
 </p>
 
 <details>
-  <summary>Tabla de contenidos</summary>
+  <summary>Table of Contents</summary>
   <ol>
     <li>
-      <a href="#🖥️-desarrolladores-del-proyecto">
-         Desarrolladores del proyecto.
+      <a href="#🖥️-project-developers">
+         Project developers.
       </a>
     </li>
     <li>
-      <a href="#🗺️-descripción-del-proyecto">
-         Descripción del proyecto.
+      <a href="#🗺️-project-description">
+         Project description.
       </a>
       <ol>
          <li>
-            <a href="#🛠-pila-de-tecnologías">
-               Pila de tecnologías.
+            <a href="#🛠-tech-stack">
+               Tech stack.
             </a>
          </li>
       </ol>
     </li>
     <li>
-      <a href="#📑-instrucciones-de-despliegue">
-         Instrucciones de despliegue.
+      <a href="#📑-deployment-instructions">
+         Deployment instructions.
       </a>
       <ol>
          <li>
-            <a href="#despliegue-utilizando-docker">
-               Despliegue con Docker.
-            </a>
-         </li>
-         <li>
-            <a href="#despliegue-nativo-(node)">
-               Despliegue nativo (Node).
+            <a href="#native-deployment-(node)">
+               Native deployment (Node).
             </a>
          </li>
       </ol>
     </li>
   </ol>
 </details>
 
-## 🖥️ Desarrolladores del proyecto:
+## 🖥️ Project developers:
 <img align="right" width="200" height="200" src="designs/measuring_oil.gif">
 
-|       Desarrolladores        |        UOs         |                                                       Perfiles de GitHub                                                       |
+|       Developers        |        UOs         |                                                       GitHub Profiles                                                       |
 |:----------------------------:|:------------------:|:------------------------------------------------------------------------------------------------------------------------------:|
 |    Carlos Diez Fernández     | [email protected] |  <a href="https://github.com/uo284373"><img alt="Carlos" src="https://img.shields.io/badge/UO284373-Carlos Diez-success"></a>  |
 |    Raúl Fernández España     | [email protected] |   <a href="https://github.com/UO278036"><img alt="Raúl" src="https://img.shields.io/badge/UO278036-Raúl Fernández-blue"></a>   |
 |    Omar Teixeira González    | [email protected] |    <a href="https://github.com/Omitg24"><img alt="Omar" src="https://img.shields.io/badge/UO281847-Omar Teixeira-red"></a>     |
 | David Leszek Warzynski Abril | [email protected] | <a href="https://github.com/UO278968"><img alt="David" src="https://img.shields.io/badge/UO278968-David Warzynski-purple"></a> |
 
 
-## 🗺️ Descripción del proyecto:
+## 🗺️ Project description:
 
 <p align="justify">
-Este proyecto se ha realizado en conjunto entre los desarrolladores anteriormente mencionados como trabajo puesto por los profesores <em>Jose Emilio Labra Gayo</em>, <em>Pablo González</em>, <em>Irene Cid Rico</em> y <em>Cristian Augusto Alonso</em> para la asignatura de <strong>Arquitectura del Software</strong> (ASW) de la Universidad de Oviedo. 
+This project has been developed jointly by the previously mentioned developers as an assignment given by the professors <em>Jose Emilio Labra Gayo</em>, <em>Pablo González</em>, <em>Irene Cid Rico</em>, and <em>Cristian Augusto Alonso</em> for the subject of <strong>Software Architecture</strong> (ASW) at the University of Oviedo.
 </p>
 <p align="justify">
-En GOMap!® los usuarios podrán iniciar sesión y desde ahí interactuar con el mundo que les rodea, de esta forma, un usuario cualquiera podría ver marcadores, los cuales también pueden ser creados por otros usuarios, sobre los lugares que se encuentran en la ubicación buscada, estos lugares pueden ir desde tiendas a bares, restaurantes, paisajes, monumentos, etc...
+In GOMap!®, users can log in and interact with the world around them. In this way, any user can view markers created by other users, or create their own, on the places located in the searched location. These places can range from shops to bars, restaurants, landscapes, monuments, and more.
 </p>
 <p align="justify">
-A estos marcadores se les podrá añadir diferentes características, como imágenes o descripción sobre el mismo, pero no acaba ahí, ya que la verdadera interacción se produce en el momento en el que se pueden añadir reviews/opiniones sobre un marcador creado por otro usuario.
+These markers can have different features added to them, such as images or a description of the location, but it doesn't end there. The real interaction comes when users can add reviews or opinions about a marker created by another user.
 </p>
 
-### 🛠 Pila de tecnologías:
+### 🛠 Tech stack:
 <p align="justify">
-La lista completa de las tecnologías empleadas, junto con sus decisiones arquitectónicas (ADR), se encuentra en el siguiente <a href="https://github.com/Arquisoft/lomap_es3a/wiki/Decisiones-Arquitectonicas">enlace</a>.
+The complete list of technologies used, along with their architectural decisions (ADR), can be found in the following <a href="https://github.com/Arquisoft/lomap_es3a/wiki/Decisiones-Arquitectonicas">link</a>.
 </p>
 <img align="right" width="200" height="200" src="designs/code.gif">
 <ul>
@@ -114,53 +125,38 @@ La lista completa de las tecnologías empleadas, junto con sus decisiones arquit
    <li><a href="https://www.openstreetmap.org/">OpenStreetMap</a>.</li>
 </ul>
 
-## 📑 Instrucciones de despliegue:
+## 📑 Deployment instructions:
 <p align="justify">
-   En primer lugar, se debe instalar <a href="https://nodejs.org/en">Node</a>. En caso de que ya esté instalado, debe asegurarse que se tiene la última versión del mismo.
-</p>
-<p align="justify">
-   Para ejecutar el proyecto, será necesario clonarlo primero, por lo que es necesario tener git (accede a través del siguiente <a href="https://git-scm.com/downloads">enlace</a>), y posteriormente, clonar este respositorio en un directorio local, ya sea descargándo el repositoio en formato <em>.zip</em> o de la siguiente manera:
+   To execute the project, it will be necessary to first clone it, so you will need to have Git installed (access through the following <a href="https://git-scm.com/downloads">link</a>), and then clone this repository into a local directory, either by downloading the repository in <em>.zip</em> format or by using the following command:
 </p>
 <img align="right" width="150" height="150" src="designs/customer-service.gif">
 <ol>
-   <li>Dirigirse al directorio local donde clonar el repositorio.</li>
-   <li>Abrir la consola o símbolo del sistema.</li>
-   <li>Escribir el siguiente código:</li>
+   <li>Go to the local directory where you want to clone the repository.</li>
+   <li>Open the console or command prompt.</li>
+   <li>Enter the following code:</li>
 </ol>
 
 ```shell
    git clone https://github.com/Arquisoft/lomap_es3a.git
 ```
 <p align="justify">
-   Una vez hecho esto, puede lanzarse de dos maneras, usando docker, o lanzando la aplicación en 2 partes.
-</p>
-
-### Despliegue utilizando Docker
-<p align="justify">
-   En caso de que se decida emplear docker, se debe situar en la raiz del directorio del proyecto y ejecutar la siguiente orden mediante consola:
-</p>
-
-```shell
-docker-compose up --build
-```
-
-<p align="justify">
-   Esto creará una imagen docker en tu sistema.
+   Once this is done, the application can be launched in the following way.
 </p>
 
-### Despliegue nativo (Node)
+### Native deployment (Node)
+#### Requisitos utilizando node
 <p align="justify">
-   En caso de que se quiera lanzar sin emplear docker, se debe compilar el proyecto y posteriormente, a través de la raíz del directorio, ejecutar las siguientes órdenes en consola:
+   Firstly, you need to install <a href="https://nodejs.org/en">Node</a>. In case it is already installed, you should make sure that you have the latest version of it.
 </p>
 
 ```shell
-# Lanzar la webapp
+# Launch the webapp
 cd webapp
 npm install
 npm start
 ```
 <p align="justify">
-A pesar de la distinción en cuanto a la forma de lanzar la aplicación, para acceder a esta (y una vez realizado uno de las dos ramas anteriores), basta con ir al siguiente <a href="http://localhost:3000">enlace</a>.
+   To access the web app (once the previous process has been completed), simply go to the following <a href="http://localhost:3000">link</a>.
 </p>
 
 <footer>