dyzur-bot/README.md

20 lines
630 B
Markdown

# Dyżur-bot
A telegram bot for managing the cleaning rota in hackerspace.
Bot offers weekly reminders about cleaning duties as well as on demand informations.
Backend read the schedule from a Google sheet, store it in local JSON file.
## Running
Requires `GOOGLE_API_KEY` and `GOOGLE_SHEETS_ID` in the environment or a `.env`
file (see `service.go`/`sheet.go` for optional `SHEET_RANGE`, `ROTA_CACHE_PATH`,
`SYNC_INTERVAL`). Then:
```sh
go run ./cmd/dyzur-bot
```
The service loads the cached rota, syncs from Google Sheets in the background on
`SYNC_INTERVAL` (default 30m), and runs until interrupted (Ctrl-C / SIGTERM).