crypto-reporter/README.md

45 lines
1.3 KiB
Markdown
Raw Normal View History

2022-09-16 19:06:53 +02:00
# crypto-reporter
[![Build Status](https://drone.cuzo.dev/api/badges/Parra/crypto-reporter/status.svg)](https://drone.cuzo.dev/Parra/crypto-reporter)
Obtiene y publica precios de criptomonedas.
## Instalación y ejecución desde CLI
Descargar el repositorio en una nueva carpeta:
````shell
git clone https://git.cuzo.dev/Parra/crypto-reporter.git
````
Copiar el fichero `env_file` a `.env` y abrirlo con un editor de textos y editarlo
con la información del servidor MQTT, así como editar los tópicos que se quieran usar
y el tiempo de refresco.
Dar permisos de ejecución al fichero principal con `chmod +x main.py` y ejecutar con `./main.py`.
## Instalación y ejecución desde Docker
Crear una carpeta (por ejemplo `crypto-reporter`) y acceder a ella.
Crear un fichero `.env` con el contenido del fichero `env_file` de este repositorio y
editarlo con la información del servidor MQTT.
Crear un fichero `docker-compose.yml` como el siguiente:
````yml
version: '3'
services:
crypto-reporter:
image: parrazam/crypto-reporter
container_name: crypto-reporter
restart: unless-stopped
volumes:
- ./.env:/.env:ro
````
Ejecutar con el comando `docker compose up -d`.
## Menciones
La API se extrae de Coingecko y se puede consultar aquí: https://www.coingecko.com/en/api/documentation