feat: implement an RSS Discord bot with slash commands for feed management and Docker support.
This commit is contained in:
56
README.md
Normal file
56
README.md
Normal file
@@ -0,0 +1,56 @@
|
||||
# RSS Discord Bot
|
||||
|
||||
Discord-Bot der RSS-Feeds überwacht und neue Einträge automatisch in einen Discord-Channel postet.
|
||||
|
||||
## Features
|
||||
|
||||
- 📰 RSS-Feeds per Slash-Command verwalten
|
||||
- 🔄 Automatische Prüfung auf neue Einträge
|
||||
- 📢 Neue Einträge werden mit Titel und Link gepostet
|
||||
- 🐳 Docker-ready
|
||||
|
||||
## Setup
|
||||
|
||||
### Lokal mit `uv`
|
||||
|
||||
```bash
|
||||
# Dependencies installieren
|
||||
uv sync
|
||||
|
||||
# .env anlegen (oder .env.example kopieren)
|
||||
cp .env.example .env
|
||||
# Token und Channel-ID eintragen
|
||||
|
||||
# Bot starten
|
||||
uv run python -m src.main
|
||||
```
|
||||
|
||||
### Mit Docker
|
||||
|
||||
```bash
|
||||
# .env anlegen
|
||||
cp .env.example .env
|
||||
# Token und Channel-ID eintragen
|
||||
|
||||
# Starten
|
||||
docker compose up -d
|
||||
|
||||
# Logs ansehen
|
||||
docker compose logs -f
|
||||
```
|
||||
|
||||
## Slash-Commands
|
||||
|
||||
| Command | Beschreibung |
|
||||
|---|---|
|
||||
| `/feed add <url>` | Neuen RSS-Feed hinzufügen |
|
||||
| `/feed remove <url>` | RSS-Feed entfernen |
|
||||
| `/feed list` | Alle gespeicherten Feeds anzeigen |
|
||||
|
||||
## Umgebungsvariablen
|
||||
|
||||
| Variable | Beschreibung | Standard |
|
||||
|---|---|---|
|
||||
| `DISCORD_TOKEN` | Discord Bot Token | *Pflicht* |
|
||||
| `DISCORD_CHANNEL_ID` | Channel-ID für Posts | *Pflicht* |
|
||||
| `CHECK_INTERVAL` | Prüf-Intervall in Sekunden | `300` |
|
||||
Reference in New Issue
Block a user