Skip to content

Commit 98f916b

Browse files
author
JuanYslaCadenas
committed
docs(readmi): modificar readmi.md
1 parent e5d2931 commit 98f916b

File tree

1 file changed

+95
-29
lines changed

1 file changed

+95
-29
lines changed

‎README.md‎

Lines changed: 95 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,81 @@
11

2-
# 📘 Digital Buho API - SOPORTE
2+
# 📘 Digital Buho API - Sistema de Soporte y Gestión Web
33

4-
Bienvenido al repositorio oficial de **Digital Buho API - SOPORTE**, un backend desarrollado con **Spring Boot** que ofrece servicios RESTful para la gestión de soporte técnico en una plataforma de cursos alternativos y accesibles.
4+
![Spring Boot Logo](https://spring.io/img/spring.svg)
5+
6+
Bienvenido al repositorio unificado de los proyectos **Digital Buho API - SOPORTE** y **Spring Boot API WEB**. Este sistema combina una API RESTful robusta y un conjunto de controladores web, desarrollado con **Spring Boot**, para la gestión integral de datos de soporte técnico y entidades empresariales.
7+
8+
---
59

610
## 🚀 Descripción General
711

8-
Esta API forma parte de una solución empresarial desarrollada para **Digital Buho SAC**, cuya misión es brindar soporte técnico eficiente y accesible para plataformas educativas. La arquitectura se basa en microservicios utilizando Spring Boot, documentada con Swagger, desplegada en la nube y lista para integrarse con diversos clientes frontend.
12+
El sistema está diseñado para resolver la problemática de accesibilidad, gestión eficiente y estandarizada de datos mediante una arquitectura RESTful, facilitando la interacción entre clientes, desarrolladores, técnicos de soporte y administradores.
13+
14+
Se implementa con Spring Boot y se documenta con Swagger para un consumo intuitivo. Está desplegado en la nube y listo para producción.
15+
16+
---
17+
18+
## 🎯 Objetivos del Proyecto
19+
20+
### Objetivo General
21+
Desarrollar una API RESTful robusta y segura para gestionar información empresarial, accesible mediante controladores REST y web.
22+
23+
### Objetivos Específicos
24+
- Implementar operaciones CRUD completas para todas las entidades.
25+
- Documentar la API utilizando Swagger.
26+
- Crear una estructura modular y escalable.
27+
- Desarrollar controladores web para vistas específicas.
28+
- Desplegar la aplicación en la nube con disponibilidad continua.
29+
30+
---
931

1032
## 🧩 Tecnologías Utilizadas
1133

1234
- **Java 17+**
13-
- **Spring Boot**
14-
- **Supabase (PostgreSQL)**
15-
- **Swagger (Documentación)**
16-
- **Postman (Pruebas)**
17-
- **Render (Despliegue en la nube)**
35+
- **Spring Boot 3.x**
36+
- **Spring Data JPA**
37+
- **PostgreSQL (Supabase)**
38+
- **Swagger / OpenAPI 3.0**
39+
- **Maven**
40+
- **Postman**
41+
- **Render (Cloud Hosting)**
42+
43+
---
1844

1945
## 📂 Estructura del Proyecto
2046

47+
### Backend Principal (`/src/main/java`)
48+
49+
```bash
50+
├── controllers/ # Controladores REST
51+
├── models/ # Entidades de la BD
52+
├── repositories/ # Interfaces de acceso a datos
53+
├── services/ # Lógica de negocio
54+
├── web/ # Controladores WEB
55+
└── ApirestApplication # Arranque del proyecto
56+
```
57+
58+
### Plantillas Web (`/src/main/resources/templates`)
59+
2160
```bash
22-
├── controller/ # Controladores REST
23-
├── model/ # Entidades del dominio
24-
├── repository/ # Interfaces de acceso a datos
25-
├── service/ # Lógica de negocio
26-
├── configuration/ # Configuraciones generales
61+
├── web-asignacion/ # Vistas del CRUD de ASIGNACION
62+
├── web-cliente/ # Vistas del CRUD de CLIENTE
63+
├── web-desarrollador/ # Vistas del CRUD de DESARROLLADOR
64+
├── web-estado/ # Vistas del CRUD de ESTADO
65+
├── web-notificacion-cliente/ # Vistas del CRUD de NOTIFICACION C
66+
├── web-notificacion-desarrollador/ # Vistas del CRUD de NOTIFICACION D
67+
├── web-persona/ # Vistas del CRUD de PERSONA
68+
├── web-revision/ # Vistas del CRUD de REVISION
69+
├── web-rol/ # Vistas del CRUD de ROL
70+
├── web-solicitud/ # Vistas del CRUD de SOLICITUD
71+
├── web-tecnico/ # Vistas del CRUD de TECNICO
72+
├── web-usuario/ # Vistas del CRUD de USUARIO
73+
├── index.html/ # Vista Principal de la WEB
2774
└── application.properties # Configuración del proyecto
2875
```
2976

77+
---
78+
3079
## 🌐 Endpoints RESTful
3180

3281
| Método | Ruta | Acción |
@@ -37,35 +86,52 @@ Esta API forma parte de una solución empresarial desarrollada para **Digital Bu
3786
| PUT | `/api/{tabla}/actualizar/{id}`| Actualizar |
3887
| DELETE | `/api/{tabla}/eliminar/{id}` | Eliminar |
3988

40-
## 🔎 Documentación
89+
---
4190

42-
La API cuenta con documentación Swagger integrada para facilitar el desarrollo y pruebas. Una vez desplegada, accede a:
91+
## 🧪 Pruebas y Documentación
92+
93+
- **Postman**: Incluye pruebas para cada operación CRUD.
94+
- **Swagger**: Documentación interactiva disponible en:
4395

4496
```
45-
https://digital-buho-api-soporte.onrender.com/swagger-ui/index.html
97+
https://spring-boot-api-web.onrender.com/swagger-ui/index.html
4698
```
4799

48-
## 📦 Pruebas con Postman
100+
---
101+
102+
## 🛠 Instalación y Ejecución Local
103+
104+
### Requisitos Previos
49105

50-
Todas las rutas han sido probadas con Postman, incluyendo los métodos:
106+
- Java JDK 17+
107+
- Maven 3.6+
51108

52-
- `GET`: Listado general e individual.
53-
- `POST`: Creación de registros.
54-
- `PUT`: Actualización de datos.
55-
- `DELETE`: Eliminación de entradas.
109+
### Pasos
56110

57-
## ☁️ Despliegue
111+
```bash
112+
git clone https://github.com/SiologoDr/Spring-Boot-API-WEB.git
113+
cd Spring-Boot-API-WEB
114+
mvn clean install
115+
mvn spring-boot:run
116+
```
117+
118+
Aplicación disponible en: `http://localhost:8080`
58119

59-
El proyecto está **en producción** gracias a Render y accesible en el siguiente enlace:
120+
---
60121

61-
🔗 [API en producción](https://digital-buho-api-soporte.onrender.com/)
122+
## ☁️ Despliegue en Producción
62123

63-
## 📎 Enlaces del Proyecto
124+
- 🌐 [API Web Desplegada](https://spring-boot-api-web.onrender.com/)
64125

65-
- 🔗 [Repositorio en GitHub](https://github.com/SiologoDr/Digital-Buho-API-SOPORTE)
66-
- 🔗 [API en la nube](https://digital-buho-api-soporte.onrender.com/)
126+
---
67127

68128
## 👤 Autor
69129

70130
**Digital Buho SAC**
71-
Proyecto desarrollado en el marco de un curso de negocios modernos con tecnología Java Spring Boot.
131+
Proyecto desarrollado como parte de una solución empresarial y académica usando tecnologías modernas Java con Spring Boot.
132+
133+
---
134+
135+
## 📝 Licencia
136+
137+
Licenciado bajo la Licencia MIT. Ver el archivo [LICENSE](LICENSE) para más detalles.

0 commit comments

Comments
 (0)