oscarmlage/heating-monitor
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Minor README fixes

Browse Source
This commit is contained in:
Óscar M. Lage 2024-11-28 13:57:46 +01:00
parent aef11ed05a
commit 57196d9189
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -10,19 +10,19 @@ Este comando inicia un servidor web que permite visualizar los eventos de calefa
#### Uso: #### Uso:
```bash ```bash
go run cmd/web/main.go $ go run cmd/web/main.go
``` ```
#### Opciones: #### Opciones:
- WEB_PORT: Puerto en el que se ejecuta el servidor web. Puedes configurarlo en el archivo .env. - WEB_PORT: Puerto en el que se ejecuta el servidor web. Puedes configurarlo en el archivo `.env`.
### 2. Comando Bot ### 2. Comando Bot
Este comando inicia un bot de Telegram que permite interactuar con el sistema de calefacción a través de mensajes. Este comando inicia un bot de Telegram que permite interactuar con el sistema de calefacción a través de mensajes.
#### Uso: #### Uso:
```sh ```sh
go run cmd/bot/main.go $ go run cmd/bot/main.go
``` ```
#### Opciones: #### Opciones:
@ -36,9 +36,10 @@ Este comando importa los datos de un archivo CSV (con formato específico) a la
#### Uso: #### Uso:
``` ```
go run cmd/import/main.go -f /ruta/al/archivo.csv $ go run cmd/import/main.go -f /ruta/al/archivo.csv
-f, --file: Especifica la ruta del archivo CSV a importar. -f, --file: Especifica la ruta del archivo CSV a importar.
--dry-run: Muestra los datos que se importarían sin hacer cambios en la base de datos (útil para verificar la información antes de insertarla). --dry-run: Muestra los datos que se importarían sin hacer cambios en la base de datos
(útil para verificar la información antes de insertarla).
``` ```
#### Configuración #### Configuración
@ -46,7 +47,7 @@ go run cmd/import/main.go -f /ruta/al/archivo.csv
1. Crear archivo .env 1. Crear archivo .env
Copia el archivo .env.sample a .env y configura las variables de entorno necesarias: Copia el archivo .env.sample a .env y configura las variables de entorno necesarias:
```sh ```sh
cp .env.sample .env $ cp .env.sample .env
``` ```
Luego edita el archivo .env con los valores correspondientes: Luego edita el archivo .env con los valores correspondientes:
```ini ```ini
@ -58,14 +59,14 @@ WEB_PORT=9900
``` ```
2. Base de Datos 2. Base de Datos
El proyecto utiliza una base de datos SQLite para almacenar los eventos de calefacción. La configuración de la base de datos se gestiona automáticamente a través del código en el archivo internal/config/db.go. Asegúrate de que el archivo de la base de datos se encuentra en la ubicación correcta para que la conexión funcione correctamente. El proyecto utiliza una base de datos SQLite para almacenar los eventos de calefacción. La configuración de la base de datos se gestiona automáticamente a través del código en el archivo `internal/config/db.go`. Asegúrate de que el archivo de la base de datos se encuentra en la ubicación correcta para que la conexión funcione correctamente.
### Dependencias ### Dependencias
Este proyecto utiliza varias dependencias de Go. Asegúrate de tenerlas instaladas y configuradas correctamente: Este proyecto utiliza varias dependencias de Go. Asegúrate de tenerlas instaladas y configuradas correctamente:
```sh ```sh
go mod tidy $ go mod tidy
``` ```
### Estructura del Proyecto ### Estructura del Proyecto