TelegramAktienBot/README.md
2022-03-15 15:04:32 +01:00

25 lines
928 B
Markdown

[![Build Status](https://drone.flokaiser.com/api/badges/H4CK3R-01/TelegramAktienBot/status.svg?ref=main)](https://drone.flokaiser.com/H4CK3R-01/TelegramAktienBot)
# TelegramAktienBot
WebEngineering2 Projekt: Aktien und News Bot für Telegram
## Projektumfang
- Web-Konfigurationsseite / Interface:
- regelmäßige Updates festlegen
- Aktienindizes auswählen
- Watchlist-Übersicht
- Verknüpfung des Bots über ID
- Login (JWT)
- Stichwörter für News definieren
- Telegram Bot:
- regelmäßige Updates per Nachricht über Kurse und News zu bestimmten Themen/Stichwörtern/Kursen
- Update auf Anfrage
## Dokumentation
- Postman-API -> docs/postman.json
- Datenbank -> database/*
## Local setup for telegram bot
1. create .env and set API keys etc. (use .env.example for this)
2. install required libs via ``pip install -r ./telegram_bot/requirements.txt``
3. run bot.py via ``python ./telegram_bot/bot.py``