https://github.com/luislh-dev/historialplus
https://github.com/luislh-dev/historialplus
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/luislh-dev/historialplus
- Owner: luislh-dev
- Created: 2024-10-31T16:15:56.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-17T13:18:39.000Z (about 1 year ago)
- Last Synced: 2025-02-05T14:39:51.269Z (about 1 year ago)
- Language: Java
- Size: 494 KB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://deepwiki.com/luislh-dev/HistorialPlus)
# HistorialPlus 📋
HistorialPlus es una aplicación web diseñada para gestionar registros históricos. Este documento proporciona una guía
para configurar, instalar y ejecutar el proyecto en tu entorno local.
## Antes de comenzar 🚀
Asegúrate de tener los siguientes requisitos:
- Java SDK 21
- Plugin para .env: Para que la aplicación funcione correctamente, necesitarás un plugin que maneje variables de entorno definidas en un archivo .env.
> [!NOTE]
> No es obligatorio usar un archivo `.env` junto con el plugin, siempre que las variables de entorno definidas en `example.env` estén configuradas en el sistema.
## Pasos para configurar el proyecto
1. Clona el repositorio
Realiza un fork del repositorio original y luego clona tu fork a tu máquina local:
```
git clone https://github.com/LuisLopez-developer/HistorialPlus.git
```
2. Ingresa al directorio
```
cd HistorialPlus
```
3. Crear y configurar el archivo `.env`
Utiliza el archivo `example.env` proporcionado como plantilla. Copia el contenido de `example.env` y crea un nuevo archivo `.env`:
```
cp example.env .env
```
> [!IMPORTANT]
> Asegúrate de que el contenido del archivo `.env` este completo, y con las credenciales correctas.
## Configuración de Git Hooks
El proyecto incluye hooks de Git para asegurar la calidad del código. **Se configuran automáticamente al ejecutar o construir el proyecto con Gradle** (por ejemplo, usando la opción de "Run" en tu IDE o ejecutando `./gradlew build` en la terminal).
1. **pre-commit**: Ejecuta `checkstyleMain`
2. **pre-push**: Antes de hacer push, ejecuta:
- `checkstyleMain` en todo el proyecto.
- Todos los tests (`./gradlew test`).
- Verifica que el proyecto compile correctamente (`./gradlew compileJava`).
3. **commit-msg**: Válida el formato del mensaje de commit.
El mensaje debe seguir la convención:
`tipo(ámbito-opcional): descripción (máx 50 chars)`
Tipos válidos: feat, fix, docs, style, refactor, test, chore, build, ci, perf, revert
Ejemplos válidos:
- `feat: agregar login con Google`
- `feat(auth): agregar login con Google`
- `refactor(user): optimizar consulta de usuarios`
> [!TIP]
> No necesitas instalar los hooks manualmente. Simplemente, ejecuta el proyecto o cualquier tarea de Gradle y los hooks se instalarán o actualizarán automáticamente en `.git/hooks`.
### Configuración manual (solo si es necesaria)
```bash
git config core.hooksPath githooks
chmod +x githooks/*
```
## Análisis de código con SonarQube y SonarCloud 🔍
Este proyecto está integrado con **SonarCloud** para asegurar la calidad del código. También puedes usar **SonarQube for IDE** en tu IDE en modo conectado.