alirezajavadi/framebot

FrameBot is a fast and secure framework that offers an ORM similar to Eloquent, making it incredibly user-friendly and powerful for developers looking to handle database operations efficiently. Designed with OOP principles in mind, FrameBot provides a robust foundation for building scalable applicat

2.13.0 2025-02-13 21:00 UTC

Requires

• php: ^8.1
• guzzlehttp/guzzle: ^7.8
• vlucas/phpdotenv: ^5.6

MIT

• Alireza javadi

README

A Modern PHP Framework for Telegram Bot Development & Database Management

Fast · Secure · Eloquent-style ORM · Telegram API First

📺 Getting Started Video

✨ Key Features

🗄️ Database Superpowers

• Eloquent-style ORM - Familiar Active Record implementation

  $user = User::find(1)->update(['username' => 'framebot_user']);

• Migrations System - Version-controlled database schema management
• Relationship Support - HasMany, BelongsTo, Polymorphic relations

🤖 Telegram Integration

• Auto-Send Architecture - RAII pattern for seamless API calls

 Message::chatId($this->chatID)->text("welcome to my telegram bot");
 // Automatically sends on destruct

25+ API Components - Pre-built classes for:

• 📍 Locations & Venues
• 🎲 Interactive Dice/Polls
• 💌 Media Groups & Paid Content
• 🎭 Message Reactions

🛡️ Security First

• Dotenv Implementation - Secure credential management
• Auto-Sanitization - Built-in parameter validation
• Request Throttling - Protection against API abuse

Section 3: Quick Start

🚀 Quick Start

Requirements

• PHP 8.0+
• Composer
• MySQL

Installation

git clone https://github.com/alirezajavadigit/framebot.git
cd framebot
composer install
cp .env.example .env

Configuration (.env)

# Telegram Configuration
TOKEN=your_bot_token_here
APP_ENV=production

# Database Settings
DB_HOST=127.0.0.1
DB_NAME=framebot
DB_USERNAME=root
DB_PASSWORD=

Section 5: Contributing & Community

🤝 Contributing

We welcome contributions! Please follow these steps:

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit changes (git commit -m 'Add some amazing feature')
4. Push to branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Contribution Guidelines:

• Follow PSR-12 coding standards
• Include PHPDoc comments
• Add unit tests for new features
• Update documentation accordingly

🌍 Community

• GitHub Discussions - Q&A and general help
• Telegram Channel - Announcements & updates & Q&A

📜 License

MIT License - See LICENSE for full text

Created with ❤️ by Alireza Javadi
Part of the Open Source Telegram Bot Ecosystem 🤖