Actualizar README.md
This commit is contained in:
parent
b7db066596
commit
5804263d09
90
README.md
90
README.md
@ -1,2 +1,92 @@
|
|||||||
# expenses_manager
|
# expenses_manager
|
||||||
|
|
||||||
|
## Descripción
|
||||||
|
expenses_manager es una aplicación diseñada para ayudarte a gestionar tus gastos diarios. Fue creada con la intención de hacer que el seguimiento de finanzas personales sea más sencillo y eficiente.
|
||||||
|
|
||||||
|
## Uso Básico
|
||||||
|
La aplicación permite:
|
||||||
|
- Registrar ingresos y egresos.
|
||||||
|
- Visualizar tus gastos por categoría.
|
||||||
|
- Generar informes financieros mensuales y semanales.
|
||||||
|
|
||||||
|
## Índice
|
||||||
|
1. [Instalación](#instalación)
|
||||||
|
2. [Configuración](#configuración)
|
||||||
|
3. [Uso](#uso)
|
||||||
|
|
||||||
|
## Instalación
|
||||||
|
|
||||||
|
### Despliegue en Local
|
||||||
|
|
||||||
|
#### Requisitos:
|
||||||
|
- Python 3.8 o superior.
|
||||||
|
- pip.
|
||||||
|
|
||||||
|
#### Pasos:
|
||||||
|
1. Clona el repositorio usando Git:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git clone https://gitea.kuijper.es/jkuijperm/expenses_manager.git
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Navega al directorio del proyecto:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cd expenses_manager
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Instala las dependencias necesarias:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
pip install -r requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
### Despliegue en Docker
|
||||||
|
|
||||||
|
#### Pasos:
|
||||||
|
1. Clona el repositorio usando Git:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git clone https://gitea.kuijper.es/jkuijperm/expenses_manager.git
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Navega al directorio del proyecto:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cd expenses_manager
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Construye la imagen Docker:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
docker build -t expenses_manager .
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Corre el contenedor:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
docker run -p 5000:5000 expenses_manager
|
||||||
|
```
|
||||||
|
|
||||||
|
## Configuración
|
||||||
|
|
||||||
|
Después de clonar el repositorio y instalar las dependencias, puedes configurar la aplicación creando un archivo `.env` en el directorio raíz del proyecto con el siguiente contenido:
|
||||||
|
|
||||||
|
env
|
||||||
|
|
||||||
|
SECRET_KEY=mi_clave_secreta_única_y_segura
|
||||||
|
|
||||||
|
DATABASE_URL=sqlite:///expenses.db # Otra URL de base de datos si es necesario
|
||||||
|
|
||||||
|
## Uso
|
||||||
|
|
||||||
|
1. Inicia la aplicación:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
python app.py
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Abre tu navegador y visita `http://localhost:5000` para acceder a la interfaz de usuario.
|
||||||
|
|
||||||
|
### Registro de Gastos
|
||||||
|
- Accede a la página de gastos y agrega nuevos registros manualmente o importa datos desde otras fuentes.
|
||||||
Loading…
Reference in New Issue
Block a user