Skip to content

docs: updated README with Telegram bot setup #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Iventyk merged 2 commits into from
Jan 19, 2026
Merged

docs: updated README with Telegram bot setup #39

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e73bce
docs: updateÐdREADME with Telegram bot setup
Iventyk Jan 19, 2026
2d58a2f
docs: updated README with Telegram bot setup
Iventyk Jan 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,33 @@ Load initial demo data fixture:
docker-compose exec library python manage.py loaddata fixtures/initial_data.json
```


## Telegram Bot Setup

The project supports Telegram notifications via a bot.

### 1. Create a Telegram Bot
- Open Telegram and start a chat with **@BotFather**
- Create a new bot using `/newbot`
- Save the generated **BOT_TOKEN**

### 2. Get your Chat ID
- Start a chat with your bot or add the bot to group chat as admin
- Send any message to it
- Open in browser:
`https://api.telegram.org/bot<BOT_TOKEN>/getUpdates` (paste your BOT_TOKEN)
- Copy the `chat.id` value

### 3. Environment variables

Add the following variables to your `.env` file:

```env
TELEGRAM_BOT_TOKEN="your_bot_token"
TELEGRAM_CHAT_ID="your_chat_id"
```


## Running Tests

```bash
Expand Down