https://github.com/soltanoff/aiogram_template

This is just a project template for writing telegram bots.
https://github.com/soltanoff/aiogram_template

aiogram aiogram-bot bot docker-compose dotenv telegram-bot telegram-bot-example template

Last synced: about 1 month ago
JSON representation

This is just a project template for writing telegram bots.

• Host: GitHub
• URL: https://github.com/soltanoff/aiogram_template
• Owner: soltanoff
• License: mit
• Created: 2023-02-28T08:25:46.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-11-23T16:20:21.000Z (about 2 months ago)
• Last Synced: 2024-11-23T17:21:55.177Z (about 2 months ago)
• Topics: aiogram, aiogram-bot, bot, docker-compose, dotenv, telegram-bot, telegram-bot-example, template
• Language: Python
• Homepage:
• Size: 131 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# aiogram bot template (skeleton)

[![\[Telegram\] aiogram live](https://img.shields.io/badge/telegram-aiogram-blue.svg?style=flat-square)](https://t.me/aiogram_live)

[![Supported python versions](https://img.shields.io/pypi/pyversions/aiogram.svg?style=flat-square)](https://pypi.python.org/pypi/aiogram)

[![Telegram Bot API](https://img.shields.io/badge/Telegram%20Bot%20API-8.0-blue.svg?style=flat-square&logo=telegram)](https://core.telegram.org/bots/api)

[![MIT License](https://img.shields.io/pypi/l/aiogram.svg?style=flat-square)](https://opensource.org/licenses/MIT)

This is just a project template for writing telegram bots. The project has linter, logger, docker, dot-env configured.

## Features

- SQLite (user info storage)

- custom aiogram middlewares ([middlewares.py](app/bot_controller/middlewares.py))

- custom aiogram router ([router.py](app/bot_controller/router.py))

## Command list

- `/help` - view all commands

- `/start` - base command for user registration

- `/hello` - just hello command

- `/user_info` - just hello command

## How to run

### Without Docker:

- Make virtual environment

- Install package requirements

- Create `.env` or set env-variables as you like (example: [.env.default](.env.default))

- Run it! :)

### With Docker

- Create `.env` or set env-variables as you like (example: [.env.default](.env.default)

  and see [docker-compose.yml](docker-compose.yml))

- Run it! :)

## Development tools

More helpful commands in [Makefile](Makefile).