Skip to content

Commit a21aa5b

Browse files
authored
Update README.md
Add docker, docker hub, docker compose, heroku explaination and jesus's contribution
1 parent 01c9ab3 commit a21aa5b

File tree

1 file changed

+85
-0
lines changed

1 file changed

+85
-0
lines changed

README.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -327,6 +327,91 @@ https://trello.com/b/CO5xGXpN/daw-2021-2022
327327
* **com.sun.mail:**
328328
* javax.mail (v1.6.2)
329329

330+
# Fase 3
331+
332+
## Intrucciónes Docker, Docker compose y Heroku
333+
334+
* Docker (Base de datos PostgreSQL): docker run -d --name postgres-server -p 5433:5432 -e "POSTGRES_PASSWORD=password" postgres
335+
* Docker Hub: docker run -d --publish 8443:8443 jesusbarcia/codeurjc-daw-2021-22-webapp4
336+
* Heroku: https://codeurjc-daw-2021-22-webapp4.herokuapp.com/
337+
338+
### Docker:
339+
Para crear la imagen docker y subirla a Docker Hub hemos creado un script (create_docker_image.sh) que se encarga de crear la imagen a partir del Dockerfile y subirla a Docker Hub con el nombre que le hemos pasado como parámetro.
340+
341+
### Docker compose
342+
Hemos creado un fichero docker-compose.yml para la ejecución de nuestra aplicación a partir de la imagen subida anteriormente a Docker Hub.
343+
Crea dos contenedores, uno para la aplicación y otro para la base de datos y sirve la web en el puerto 8443.
344+
También hay otro fichero docker-compose-local.yml que hace lo mismo que el anterior a excepción de que en lugar de descargar la imagen de Docker Hub la crea a partir de los ficheros que tenemos en local.
345+
346+
### Heroku
347+
Hemos creado dos scripts, create_heroku_app.sh y deploy_heroku_app.sh.
348+
El primero se encarga de generar el contenedor en Heroku, crear la base de datos PostgreSQL y configurar las variables de entorno necesarias.
349+
El segundo se encarga de crear la imagen docker a partir del Dockerfile, subirla y desplegar la aplicación totalmente operativa.
350+
351+
## Diagrama de clases y templates
352+
353+
![](ScreenshotsFase3/diagramaClasesTemplatesWallypopModificado.jpg)
354+
355+
## Contribución miembros equipo
356+
357+
### -> Contribución Iván:
358+
359+
#### --> Descripción textual
360+
361+
##### ---> He participado en la implementación de la funcionalidad de publicar nuevos anuncios de la API REST.
362+
##### ---> He participado en la implementación de la funcionalidad de cambiar el estado de un anuncio (vendido/reservado) anuncios de la API REST.
363+
##### ---> He participado en la implementación de la funcionalidad de borrar/modificar anuncios de la API REST.
364+
##### ---> He participado en la implementación de mostrar anuncios con métodos pageables de la API REST.
365+
##### ---> Realizado la modificación del diagrama de clases y templates para la FASE 3 (Ampliación del diagrama realizado en la FASE 2)
366+
367+
#### --> 5 Commits más significativos:
368+
369+
##### ---> Creación controlador de artículos para la API REST: https: //github.com/CodeURJC-DAW-2021-22/webapp4/commit/403889779c7e5dff1cd256979f5b602195bde1fd
370+
##### ---> Primer intento de implementación del método utilizado para módificar un árticulo de la API REST: https: //github.com/CodeURJC-DAW-2021-22/webapp4/commit/9a26c9a8862acfa22b162017d402d5a9be4a57dc2
371+
##### ---> Primer intento de implementación del método utilizado para mostrar árticulos con métodos pageables de la API REST: https: //github.com/CodeURJC-DAW-2021-22/webapp4/commit/622b30cfc56a22f9672a7a4538964c316e27b4ab
372+
##### ---> Pagination con métodos pageables: https: //github.com/CodeURJC-DAW-2021-22/webapp4/commit/6180d875fab39accce19592a21444b4e120d7cea
373+
##### ---> Crear/borrar/modificar anuncios funciona: https://github.com/CodeURJC-DAW-2021-22/webapp4/commit/a114494b0cb46c89deadc08778fc66c3831ca2cc
374+
375+
376+
#### --> 5 ficheros mayor participación:
377+
378+
##### ---> https://github.com/CodeURJC-DAW-2021-22/webapp4/blob/API_Articles_Merge/backend/src/main/java/es/codeurjc/wallypop/controller/api/ArticleRestController.java
379+
##### ---> https://github.com/CodeURJC-DAW-2021-22/webapp4/blob/API_Articles/backend/src/main/java/es/codeurjc/wallypop/service/ArticleService.java
380+
##### ---> https://github.com/CodeURJC-DAW-2021-22/webapp4/blob/API_Articles/backend/src/main/java/es/codeurjc/wallypop/repository/ArticleRepository.java
381+
##### ---> https://github.com/CodeURJC-DAW-2021-22/webapp4/blob/API_Articles/backend/src/main/java/es/codeurjc/wallypop/model/Article.java
382+
##### ---> https://github.com/CodeURJC-DAW-2021-22/webapp4/blob/API_Articles_2/README.md
383+
384+
### -> Contribución Jesús:
385+
386+
#### --> Descripción textual
387+
388+
##### ---> Creación de la api de usuarios (GET, POST, PUT y DELETE)
389+
##### ---> GET de artículos para un usuario propio
390+
##### ---> Creación de algunos métodos para las api de los administradores para los distintos modelos
391+
##### ---> Resolver problema con las recursión infinitas al hacer un GET debido a las relaciones entre modelos
392+
##### ---> Securizar todas las urls de la api
393+
##### ---> Añadir seguridad al uso de la api con JWT
394+
##### ---> Sustitución del envío de la contraseña en claro por la generación de un token único
395+
##### ---> Dockerizar aplicación y despliegue en Heroku
396+
##### ---> Clase java para coger la URI de la base de datos de Heroku
397+
##### ---> Reintentos de conexión a la base de datos cuando no está disponible
398+
399+
#### --> 5 Commits más significativos:
400+
401+
##### ---> https://github.com/CodeURJC-DAW-2021-22/webapp4/commit/d071b45d1cda31b9da07487b08b188f9c9c7fd22
402+
##### ---> https://github.com/CodeURJC-DAW-2021-22/webapp4/commit/bc5b798308f41ea9eda3b17ae0fe324ee684ae7d
403+
##### ---> https://github.com/CodeURJC-DAW-2021-22/webapp4/commit/6aab8e9657ced95d9ebbdcf9f4b49332bcbae429
404+
##### ---> https://github.com/CodeURJC-DAW-2021-22/webapp4/commit/f2cf8ed74c929cf1b546e2af6bc3032fce69f84f
405+
##### ---> https://github.com/CodeURJC-DAW-2021-22/webapp4/commit/846d01f4714a867533fac090bc28e4a92b859b13
406+
407+
408+
#### --> 5 ficheros mayor participación:
409+
410+
##### ---> https://github.com/CodeURJC-DAW-2021-22/webapp4/tree/main/backend/src/main/java/es/codeurjc/wallypop/dto
411+
##### ---> https://github.com/CodeURJC-DAW-2021-22/webapp4/blob/main/backend/src/main/java/es/codeurjc/wallypop/security/RestSecurityConfig.java
412+
##### ---> https://github.com/CodeURJC-DAW-2021-22/webapp4/blob/main/backend/src/main/java/es/codeurjc/wallypop/controller/api/UserRestController.java
413+
##### ---> https://github.com/CodeURJC-DAW-2021-22/webapp4/blob/main/backend/src/main/java/es/codeurjc/wallypop/controller/api/admin/AdminUserRestController.java
414+
##### ---> https://github.com/CodeURJC-DAW-2021-22/webapp4/blob/main/backend/deploy_heroku_app.sh
330415

331416
## Licencia
332417
[APACHE](https://github.com/CodeURJC-DAW-2021-22/webapp4/blob/26b1d22bc7625b0dd8cdb3a3b8eaf7bb5425833b/LICENSE)

0 commit comments

Comments
 (0)