Skip to content

smrf1093/tele-portfolio

Repository files navigation

TelePortfolio

made-with-python ci LICENSE

Overview

TelePortFolio is your personal cryptocurrency portfolio tracking/alerting software. this software is made using Covalent api, Flask, Influxdb and Telegram api.

TelePortfolio

Demo

Demo dashboard: http://185.235.41.84:5000/

Quickstart

Create a .env file

This app reads configuration from a dot env file. see example:

$ cat env.example
 BOT_TOKEN=your bot token
 SECRET_KEY=long alphanumeric string
 COVALENT_API_KEY=covalent api key
 INFLUXDB_HOST=localhost
 INFLUXDB_PORT=8086
 CURRENCY_SIGN=$

Please move this file to .env and provide your configurations:

$ move env.example .env 

Create a telegram bot

To enable alerting functionallity you need to provide a BOT_TOKEN. To creat a bot please follow the instructions in here

Find your chat id

This app uses BOT_CHATID to send a direct telegram message to the wallet owner. to find your chat id you can use this telegram bot.

Run using docker

This app consist of two components: An alerting component that alert when there is a change in portfolio balance value, second a flask app that provides a dashboard to view current portfolio.

You can simply run both components using docker-compose:

docker-compose up -d

Next open up your browser and head to https://localhost:5000 to see the dashboard

Credits

This software is powered by Covalent api. so special thanks to Covalent for the awesome api <3 powered by

License

See LICENSE.md

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages