Skip to content

README.md

Latest commit

 

History

History
62 lines (48 loc) · 2.12 KB

README.md

File metadata and controls

62 lines (48 loc) · 2.12 KB

⭐️ Split.tg bot

Website Telegram Telegram License Pipeline

About

Buy Telegram Stars and Telegram Premium easily with @FishStarsBot!

System dependencies

  • Python 3.11+
  • Docker
  • docker-compose
  • make
  • uv

🐳 Quick Start with Docker compose

  • Rename .env.dist to .env and configure it
  • Rename docker-compose.example.yml to docker-compose.yml
  • Run make app-build command then make app-run to start the bot

Use make to see all available commands

🔧 Development

Setup environment

uv sync

Update database tables structure

Make migration script:

make migration message=MESSAGE_WHAT_THE_MIGRATION_DOES

Run migrations:

make migrate

🚀 Used technologies:

  • uv (an extremely fast Python package and project manager)
  • Aiogram 3.x (Telegram bot framework)
  • PostgreSQL (persistent relational database)
  • SQLAlchemy (working with database from Python)
  • Alembic (lightweight database migration tool)
  • Redis (in-memory data storage for FSM and caching)
  • Project Fluent (modern localization system)

🤝 Contributions

🐛 Bug Reports / ✨ Feature Requests

If you want to report a bug or request a new feature, feel free to open a new issue.

Pull Requests

If you want to help us improve the bot, you can create a new Pull Request.

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.