https://github.com/arturboyun/aiogrambottemplate
This is a template for easy start of bot development for Telegram
https://github.com/arturboyun/aiogrambottemplate
aiogram aiogram-bot aiogram-bot-template aiogram-dialog aiogram-template aiogrambot bot dishka docker fastapi python ruff sqlalchemy telegram telegram-bot uv
Last synced: about 2 months ago
JSON representation
This is a template for easy start of bot development for Telegram
- Host: GitHub
- URL: https://github.com/arturboyun/aiogrambottemplate
- Owner: arturboyun
- License: mit
- Created: 2020-07-27T11:50:31.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-30T17:32:18.000Z (about 2 months ago)
- Last Synced: 2025-03-30T18:28:50.628Z (about 2 months ago)
- Topics: aiogram, aiogram-bot, aiogram-bot-template, aiogram-dialog, aiogram-template, aiogrambot, bot, dishka, docker, fastapi, python, ruff, sqlalchemy, telegram, telegram-bot, uv
- Language: Python
- Homepage:
- Size: 119 KB
- Stars: 106
- Watchers: 3
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📋 Telegram Bot Template
This template provides clean start to create bot using aiogram.
## 🛠 Stack
- Aiogram
- Aiogram Dialog
- Dishka
- Pydantic
- FastAPI
- ~~I18n~~ (TODO)
- ~~Base of Clean Architecture~~ (TODO)
- ~~Ngrok for local dev~~ (TODO)
- SQLAlchemy + asyncpg
- Alembic
- UV
- Ruff
- Docker
- PostgreSQL
- Redis
## 🐳 Setup with Docker
1. Create `.env` file from `.env.dist` and fill it.
2. Create `password.txt` in `db` folder and fill it.
3. Run docker `docker compose up --build -d`
4. Run migrations with `docker compose exec -it db uv run alembic upgrade head`
## 🐇 Setup for local start
1. Create `.env` file from `.env.dist` and fill it.
2. Create `password.txt` in `db` folder and fill it.
3. Run `docker compose up --build -d db redis`
4. Install dependencies with `uv sync`
5. Create `.venv` with `uv venv --seed`
6. Activate virtual environment with `source .venv/bin/activate`
7. Run migrations with `alembic upgrade head`
8. Run bot with `python -m bot`
## 📎Start with webhook
1. Set `USE_WEBHOOK` to True in .env
2. Update `BOT_SECRET_TOKEN`
3. Set `API_HOST` to your domain
4. Update `ORIGINS` in `.env`
5. Start bot with `python -m bot`
## 🍀 For production
`docker compose -f compose.yml -f compose.prod.yml up --build -d`
## How To?
### Run migrations
```shell
alembic upgrade head
```
### Generate new migration
```shell
alembic revision --autogenerate -m ""
```
### Generate Secret Keys
Some environment variables in the .env file have a default value of changethis.
You have to change them with a secret key, to generate secret keys you can run the following command:
```shell
python -c "import secrets; print(secrets.token_urlsafe(32))"
```