Codex Bot Framework 🚀
Welcome to the codex-bot documentation — a modern Aiogram-based framework for Telegram bots, focusing on modularity, clean architecture, and rapid development.
🏗 Key Features
- Feature-based structure: Each bot function is an independent module with its own logic, UI, and handlers.
- Stateless Orchestrators: All business logic is separated from the user state, making scaling effortless.
- Smart UI Synchronization: Automatically update existing messages instead of spamming with new ones.
- Event-Driven: Built-in Redis Streams support for background task processing.
🗺 System Map
🚀 Quick Start
- Getting Started: From installation to your first bot in 5 minutes.
- CLI Engine: How to use the project and feature generator.
🏛 Architecture & Engine
- Architecture Overview: How everything works under the hood.
- Feature Discovery: The magic of automated module connection.
- Bot Factory: Flexible assembly and middleware configuration.
🛠 Core Services
- Director: Orchestrating transitions between scenes.
- ViewSender: UI delivery and message synchronization.
- FSM & States: Isolated user data storage.
- Redis Streams: Handling asynchronous events.
- Helpers: Useful utilities and ID inspector.
📚 API Reference
For detailed information on specific classes and methods, check our Technical Reference. You can also view our development plans in the Roadmap and active Backlog.