README.md

🤖 Volunteer bot in Telegram 📱

A bot created to provide support and utility knowledge aimed at your personal development and adaptation in modern times society. There are four key areas and by choosing each one you will discover opportunity to get information and ask questions to our qualified volunteer experts.

System dependencies

• Python 3.11+

• Docker

• docker-compose

• make

Deployment

1. Clone the repository:

   git clone https://github.com/Th3Kanashii/telegram-volunteer-bot.git

2. Rename .env.dist to .env and configure it:

   Rename the .env.dist file to .env and specify the necessary parameters for the bot to work.

3. Build the application and run the bot:

   Execute the following commands:

   make app-build
   make app-run

Development

Setup environment

make install

Update database tables structure

Make migration script:

make migration message=MESSAGE_WHAT_THE_MIGRATION_DOES rev_id=ID_MIGRATION

Run migrations:

make migrate

Used technologies

• Aiogram 3.x (Telegram Bot framework)
• PostgreSQL (database)
• SQLAlchemy (working with database from Python)
• Alembic (lightweight database migration tool)
• Project Fluent (modern localization system)
• APScheduler (function scheduler)