Codex Bot Framework 🚀
Добро пожаловать в документацию codex-bot — современного фреймворка для разработки Telegram-ботов на базе aiogram с акцентом на модульность, чистоту архитектуры и высокую скорость разработки.
🏗 Ключевые особенности
- Feature-based структура: Каждая функция бота — это независимый модуль со своей логикой, UI и хендлерами.
- Stateless Orchestrators: Вся бизнес-логика отделена от состояния пользователя, что упрощает масштабирование.
- Smart UI Synchronization: Автоматическое обновление сообщений вместо спама новыми уведомлениями.
- Event-Driven: Встроенная поддержка Redis Streams для обработки фоновых задач.
🗺 Карта системы
🚀 Быстрый старт
- Начало работы: От установки до первого эхо-бота за 5 минут.
- Движок CLI: Как использовать генератор проектов и фич.
🏛 Архитектура и Движок
- Обзор архитектуры: Как всё устроено под капотом.
- Feature Discovery: Магия автоматического подключения модулей.
- Bot Factory: Гибкая сборка и настройка мидлварей.
🛠 Ключевые сервисы
- Director: Координация переходов между сценами.
- ViewSender: Доставка и синхронизация интерфейса.
- FSM & States: Изолированное хранение данных пользователя.
- Redis Streams: Обработка асинхронных событий.
- Helpers: Полезные утилиты и ID-инспектор.
📚 API Reference
Если вам нужны подробности о конкретных классах и методах, загляните в наш Технический справочник. Вы также можете ознакомиться с планами развития в Roadmap и текущим Бэклогом.