Editando el README

Author: fecg2212

.gitignore

@@ -1,4 +1,3 @@
-README.md
 target/
 .mvn/wrapper/maven-wrapper.jar
 !**/src/main/**/target/

README.md

@@ -0,0 +1,159 @@
+# 🍳 MasterChef API
+
+API REST para la gestión de recetas del programa **Máster Chef Celebrity**, desarrollada con **Spring Boot** y **MongoDB Atlas**.  
+Este proyecto forma parte de la fase inicial de desarrollo del portal web del programa, donde los televidentes podrán consultar, publicar y gestionar recetas.
+
+---
+
+# 📋 Descripción del Proyecto
+
+La API permite registrar, consultar, actualizar y eliminar recetas de cocina creadas por:
+- Participantes del programa.
+- Chefs del jurado.
+- Televidentes del público general.
+
+Cada receta incluye:
+- Título
+- Lista de ingredientes
+- Pasos de preparación
+- Autor (con su tipo: participante, chef o televidente)
+- Temporada (solo si pertenece a un participante del programa)
+
+Además, el sistema expone endpoints para:
+- Buscar recetas por ingrediente.
+- Filtrar recetas según su tipo de autor.
+- Consultar recetas por temporada o por número consecutivo.
+
+---
+
+# 🧱 Tecnologías utilizadas
+
+- **Java 21**
+- **Spring Boot 3.5.6**
+- **MongoDB Atlas (NoSQL en la nube)**
+- **Maven**
+- **Swagger (Springdoc OpenAPI)** para documentación
+- **JUnit 5** para pruebas unitarias
+- **GitHub Actions** para CI/CD
+- **Azure App Service** para despliegue
+
+---
+
+# ⚙️ Instrucciones de instalación y ejecución local
+
+## 🔹 1. Crear proyecto en SpringBoot
+
+![img.png](img.png)
+
+Y ordenamos las carpetas de tal manera que quede como una arquitectura de capas donde vamos a segmentar las responsabilidades.
+
+![img_1.png](img_1.png)
+
+Luego empezamos a crear la lógica en cada carpeta para poder realizar las Apis donde:
+
+**Repository:** manejará la conexión con MongoDB.
+
+**Service:** contendrá la lógica de negocio (crear, actualizar, buscar, eliminar).
+
+**Controller:** expondrá los endpoints REST y usará Swagger para documentarlos.
+
+**Model:** las entidades de la base de datos.
+
+## 🔹 2. Creamos la base de datos en MongoDB Atlas
+
+Creamos la base de datos en Atlas ya que es accesible desde cualquier lado incluído azure, gratis, fácil de usar, se conecta con URI y es la mejor opción para el despliegue en azure + swagger.
+
+![img_2.png](img_2.png)
+
+Y ya por último ponemos la URL en el application.properties para terminar de configurarlo.
+
+![img_3.png](img_3.png)
+
+## 🔹 3. API con pruebas unitarias
+
+Una vez ya tenemos las 12 funcionalidades, realizamos las 3 pruebas que nos piden y ejecutamos el comando mvn test.
+
+![img_4.png](img_4.png)
+
+## 🔹 3. Probamos los request y response por cada Endpoint
+
+### POST /api/recetas/televidente
+
+![img_8.png](img_8.png)
+
+![img_9.png](img_9.png)
+
+### POST /api/recetas/participante
+
+![img_10.png](img_10.png)
+
+![img_11.png](img_11.png)
+
+### POST /api/recetas/chef
+
+![img_12.png](img_12.png)
+
+![img_13.png](img_13.png)
+
+### GET /api/recetas
+
+Lista de todas las recetas creadas anteriormente:
+
+![img_14.png](img_14.png)
+
+### GET /api/recetas/{id}
+
+![img_15.png](img_15.png)
+
+![img_16.png](img_16.png)
+
+### GET /api/recetas/televidente
+
+Solo recetas con tipoAutor: TELEVIDENTE
+
+![img_17.png](img_17.png)
+
+### GET /api/recetas/participante
+
+Solo recetas con tipoAutor: PARTICIPANTE
+
+![img_18.png](img_18.png)
+
+### GET /api/recetas/chef
+
+Solo recetas con tipoAutor: CHEF
+
+![img_19.png](img_19.png)
+
+### GET /api/recetas/temporada/{numero}
+
+![img_20.png](img_20.png)
+
+![img_21.png](img_21.png)
+
+### GET /api/recetas/buscar/{nombre}
+
+![img_22.png](img_22.png)
+
+![img_23.png](img_23.png)
+
+### DELETE /api/recetas/{id}
+
+![img_24.png](img_24.png)
+
+![img_25.png](img_25.png)
+
+### PUT /api/recetas/{id}
+
+![img_26.png](img_26.png)
+
+![img_27.png](img_27.png)
+
+Y con eso terminamos de probar las 12 funcionalidades de nuestra API en Swagger.
+
+
+Y comprobamos si se guardó en la base de datos en MongoDB
+
+![img_28.png](img_28.png)
+
+