Files
miband-bot/README.md
T
Alex Getman 443abffdaa Merge remote-tracking branch 'origin/main'
# Conflicts:
#	README.es-ES.md
#	README.md
2026-08-12 13:13:18 +03:00

47 lines
1.2 KiB
Markdown

# miband-bot
[Русский](README.ru.md) | English | [Español](README.es-ES.md)
Self-hosted Telegram bot for Xiaomi Fitness and Mi Band health data.
It synchronizes steps, sleep, heart rate, SpO2, stress, daily activity, weight,
and workouts into local SQLite files and lets you view or export them from Telegram.
No third-party data service is involved.
> Designed for one private owner. Not a public bot or a medical service.
## Features
- Daily health summaries, history, weekly reports, trends, family stats, and comparisons.
- Xiaomi QR login and scheduled or manual synchronization.
- CSV/ZIP export from Telegram.
- English interface by default, with Russian and Spanish switchers in Settings.
- Bun/TypeScript runtime with Docker Compose.
## Quick start
```
cp .env.example secrets.env
# Set TELEGRAM_BOT_TOKEN in secrets.env
bun install
bun run check
docker compose up -d --build
```
Runtime data is stored in `./data`. Keep `secrets.env`, `data/`, Xiaomi tokens,
SQLite databases, and exports private.
## Development
```
bun install
bun run check
bun run dev
`
The service exposes `/healthz` and `/readyz` on port `8080`.
## License
[GNU GPL v3.0 or later](LICENSE).