Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/orliluq/portfolio
API para la gestión de Portfolios. Detalles: API RESTful utilizando Java, Spring Boot y PostgreSQL.
https://github.com/orliluq/portfolio
hibernate java jpa-hibernate jpa-persistence-applications postgresql spring-boot swagger-ui
Last synced: 14 days ago
JSON representation
API para la gestión de Portfolios. Detalles: API RESTful utilizando Java, Spring Boot y PostgreSQL.
- Host: GitHub
- URL: https://github.com/orliluq/portfolio
- Owner: Orliluq
- License: mit
- Created: 2024-11-16T22:22:33.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-17T20:32:24.000Z (3 months ago)
- Last Synced: 2024-11-25T09:17:39.088Z (3 months ago)
- Topics: hibernate, java, jpa-hibernate, jpa-persistence-applications, postgresql, spring-boot, swagger-ui
- Language: Java
- Homepage:
- Size: 378 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 👩💻 Backend Portfolio (Java)
Este proyecto implementa una API RESTful en Java utilizando Spring Boot y PostgreSQL para gestionar los portafolios de usuarios. La API permite a los usuarios crear, leer, actualizar y eliminar información sobre sus proyectos, habilidades, experiencia, educación y contactos. La arquitectura se basa en relaciones entre entidades para representar de forma precisa las conexiones entre los diferentes componentes del portafolio.
## 🛠️ Tecnologías Utilizadas
- Java: Lenguaje de programación principal.
- Spring Boot: Framework Java para desarrollo de aplicaciones web.
- Spring Data JPA: Abstracción de la persistencia de datos.
- PostgreSQL: Base de datos relacional.
- Maven/Gradle: Gestor de dependencias.
## 🖥️ Estructura del Proyecto
### 📑 Entidades:
- User: Representa a un usuario con atributos como nombre, correo electrónico y una relación con sus proyectos, experiencias, educación, habilidades y contacto.
- Project: Representa un proyecto con atributos como nombre, descripción, URL, etc.
- Experience: Representa una experiencia laboral con atributos como empresa, puesto, etc.
- Education: Representa una formación académica con atributos como institución, título, etc.
- Skill: Representa una habilidad con atributos como nombre y nivel.
- Contact: Representa la información de contacto del usuario.
### 🏗️ Estructura de paquetes para Clean Architecture
src/main/java/api.portfolio
```
└── domain
└── application
└── infrastructure
└── config
└── shared
```
### 📈 Relaciones entre Entidades:
- Uno a muchos: Un usuario puede tener muchos proyectos, experiencias, educaciones y habilidades.
- Uno a uno: Un usuario tiene un único contacto.
- Muchos a uno: Un proyecto, experiencia, educación o habilidad pertenece a un único usuario.
## 📋 Diagramas de entidad-relación (ERD):
Un diagrama visual puede ayudar a comprender mejor las relaciones entre las entidades.
## 📂 Instalación y Ejecución
1. Clonar el repositorio:
```git clone https://github.com/Orliluq/portfolio.git```
2. Instalar dependencias:
```cd portfolio-backend```
- Para Maven: `mvn install`
- Para Gradle: `./gradlew build`
3. Iniciar la aplicación:
- Para Maven: `mvn spring-boot:run`
- Para Gradle: `./gradlew bootRun`
## 📊 Endpoints de la API
- Usuarios:
+ `GET /api/v1/users`: Obtener todos los usuarios
+ `GET /api/v1/users/{id}`: Obtener un usuario por ID
+ `POST /api/v1/users`: Crear un nuevo usuario
+ `PUT /api/v1/users/{id}`: Actualizar un usuario
+ `DELETE /api/v1/users/{id}`: Eliminar un usuario
- Proyectos, Experiencias, Educación, Habilidades, Contactos:... (similar a los usuarios)
# 📝 API Documentation
The API is documented using Swagger/OpenAPI. You can access the API documentation via:
Swagger UI URL: `http://localhost:8080/swagger-ui.html`
# 🏷️ License
This project is licensed under the MIT License. See the LICENSE file for details.