https://github.com/pablosilvab/home-budget-manager
https://github.com/pablosilvab/home-budget-manager
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/pablosilvab/home-budget-manager
- Owner: pablosilvab
- Created: 2024-12-05T13:29:18.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-12-16T15:10:49.000Z (5 months ago)
- Last Synced: 2025-02-08T12:46:32.594Z (3 months ago)
- Language: TypeScript
- Size: 250 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Home Budget Manager
**Home Budget Manager** es una aplicación para registrar y rastrear precios de productos a lo largo del tiempo, incluyendo coordenadas y referencias.
## Estado del Proyecto
[](https://gitlab.com/pablosilvab/home-budget-manager/-/commits/main)
[](https://sonarcloud.io/summary/new_code?id=pablosilvab_home-budget-manager)
[](https://sonarcloud.io/summary/new_code?id=pablosilvab_home-budget-manager)
---
## 🚀 Características
- Registro de precios con historial.
- Soporte para coordenadas geográficas y referencias.
- API REST robusta utilizando **NestJS**.
- Cobertura de código con **SonarCloud**.
---
## 📦 Instalación
### Prerrequisitos
Asegúrate de tener instalados los siguientes elementos en tu sistema:
- [Node.js](https://nodejs.org/) (versión 16 o superior)
- [npm](https://www.npmjs.com/) o [yarn](https://yarnpkg.com/)
- [Git](https://git-scm.com/)
### Pasos para instalar
1. Clona el repositorio:
```bash
git clone https://github.com/pablosilvab/home-budget-manager.git
cd home-budget-manager
```
2. Instalar dependencias:
```bash
npm install
```
3. Configura las variables de entorno creando un archivo .env:
```
DATABASE_URL=
```
## ⚙️ Scripts
### Desarrollo
```bash
npm run start:dev
```
Ejecuta la aplicación en modo de desarrollo.
### Pruebas
```bash
npm run test
```
### Coverage
```bash
npm run test:cov
```
Genera un reporte de cobertura de código.
## 🌐 Despliegue
El despliegue de este proyecto se realiza automáticamente en Render al ejecutar un webhook. Para habilitarlo, asegúrate de configurar la URL del webhook en las variables de entorno:
```
RENDER_URL=https://api.render.com/deploy/?key=
```
El proceso CI/CD incluye:
- Ejecución de tests unitarios.
- Verificación del umbral de cobertura de código.
- Despliegue a producción si todo está correcto.
## 🛠 Tecnologías Utilizadas
- NestJS: Framework de backend.
- Jest: Para pruebas unitarias.
- SonarCloud: Análisis de calidad y cobertura de código.
- Render: Para despliegue en producción.