docs(README): generado README.md

parent f2691f6a
Showing with 21 additions and 16 deletions
......@@ -17,7 +17,7 @@ git clone https://gitlab.ujaen.es/amaf0001/AppRecetas.git
### Paso 2 - Seleccionar IDE
Se ha desarrollado con IntelliJ
Se ha desarrollado con IntelliJ.
### Paso 3 - Seleccionar configuración de ejecución
......@@ -25,6 +25,11 @@ Si es IntelliJ Ultimate, seleccionar la opción de Spring Boot en la configuraci
Si es otra versión, no sé si hay que añadir dependencias al pom o crear el proyecto desde https://start.spring.io/ e importar la estructura.
### Paso 4 - application.properties
Crear cuenta de [Cloudinary](https://console.cloudinary.com/) e introducir las credenciales obtenidas en el archivo application.properties para realizar la conexión para
guardar/extraer las imágenes de las recetas.
### Paso 4 - Ejecutar
Se lanza en el puerto http://localhost:8080.
......@@ -39,14 +44,13 @@ Se lanza en el puerto http://localhost:8080.
* Base de Datos
- spring-boot-starter-data-mongodb -> Soporte para MongoDB.
- h2 database -> Base de datos en memoria para pruebas.
* Frontend
- spring-boot-starter-thymeleaf -> Para renderizar HTML con plantillas en el backend.
* Reutilización de código
- org.mapstruct -> para generar automáticamente el código de mapeo entre entidades y DTOs.
- org.projectlombok:lombok -> para reducir código repetitivo en las clases modelo.
**Para añadir**
- jackson-databind -> para convertir objetos Java a JSON y viceversa.
- org.projectlombok:lombok -> para reducir código repetitivo en las clases modelo.
* Cloudinary
- com.cloudinary -> para la conexión con la web donde se encuentran las imágenes de las recetas.
---
## Roles
......@@ -57,10 +61,17 @@ Se lanza en el puerto http://localhost:8080.
---
## Conexión BBDD
El acceso a la base de datos se realiza mediante la URL situada en el application-example.properties. Además, se puede acceder a MongoDB Atlas con las siguientes credenciales:
- Nombre de usuario: usuarioInvitado
- Contraseña: bienvenido.123
Este usuario solo tiene permisos de lectura sobre la base de datos (Cluster 0).
---
## Conexión con el micro servicio
Escucha en el puerto 5000 al micro servicio...
El microservicio escucha en el puerto 5000, solo hace falta ejecutarlo para que la conexión con este proyecto se realice.
---
## Estructura
......@@ -114,10 +125,5 @@ Uso de arquitectura hexagonal en tres capas:
---
## Seguridad
Se ha implementado un sistema basado en JWT y ... para la autenticación y autorización mediante token.
---
## Ejemplos de uso
---
## Conclusión
\ No newline at end of file
Se ha implementado un sistema basado en JWT para generar tokens de acceso, esto permite la autenticación de usuarios. Además, se ha restringido
el acceso a ciertos endpoints según el rol del usuario desde el archivo Security Config.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment