https://github.com/MassonNN/masson-aiogram-template

This is a scalable and functional template for any bots which will be made with aiogram 3.x
https://github.com/MassonNN/masson-aiogram-template

aiogram aiogram3 bot open-source telegram template

Last synced: 3 days ago
JSON representation

This is a scalable and functional template for any bots which will be made with aiogram 3.x

• Host: GitHub
• URL: https://github.com/MassonNN/masson-aiogram-template
• Owner: MassonNN
• License: mit
• Created: 2023-01-14T15:32:36.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-23T16:55:33.000Z (6 months ago)
• Last Synced: 2024-08-01T19:55:33.102Z (3 months ago)
• Topics: aiogram, aiogram3, bot, open-source, telegram, template
• Language: Python
• Homepage:
• Size: 229 KB
• Stars: 111
• Watchers: 2
• Forks: 17
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![template](https://user-images.githubusercontent.com/35528949/212500045-feb51ec0-e26a-45a6-bc8c-75d01379faf9.png)

![](https://img.shields.io/badge/version-0.1.3%20-brightgreen)

![](https://img.shields.io/github/license/MassonNN/masson-aiogram-template)

![](https://img.shields.io/github/forks/MassonNn/masson-aiogram-template)

![](https://img.shields.io/github/stars/MassonNn/masson-aiogram-template?style=flat-square)

[![telegram](https://img.shields.io/badge/Telegram-Join-blue)](https://t.me/massonnn_yt)

---

## Setup bot

1. Clone this repository

2. Change the name of `.env.dist` to `.env` and set all environment variables as you need

3. Change password for redis in build/redis.conf (`requirepass` and `masterauth`). Set same password in `.env` 

   (`REDIS_PASSWORD`).

4. Change project name and other information in `pyproject.toml`

5. `make project-start` to start project with docker-compose or `make help` if you want to know more about make commands

---

## Development

If you want to lint your code: \

```make lint``` \

This will start isort, blue and ruff to src and tests folders

You can manually run any instrument by: \

`make ruff`, `make blue` or `make isort`

### Migrations

`make generate NAME=` \

Generate alembic revision for migration with given name

`make migrate` \

Apply migrations to the target database

---

## Roadmap

- Add Github Actions CI/CD

- Light (simplified) version without docker and CI/CD

- Highload version with NATS and Docker Swarm

- More tests kit and update factory