diff --git a/README.md b/README.md index 35c71ce..aa1edde 100644 --- a/README.md +++ b/README.md @@ -2,53 +2,43 @@ Telegram-бот на aiogram 3, который автоматически отправляет личное сообщение пользователям, подавшим заявку в закрытый канал. -## Стек +## Запуск через .bat (Windows) -- Python 3.11 -- aiogram 3.28.2 -- SQLAlchemy 2.x -- aiosqlite -- APScheduler -- aiohttp -- pydantic-settings -- pytz +Запусти `start.bat` двойным кликом. Скрипт автоматически: -## Быстрый старт +1. Создаст виртуальное окружение `.venv` +2. Установит зависимости из `requirements.txt` +3. Создаст `.env` из примера (если ещё нет) +4. Запустит бота -1. Создание виртуального окружения: +## Запуск через командную строку (вручную) + +1. Установи Python `3.11+`. +2. Поставь зависимости: ```bash -python3.11 -m venv .venv -source .venv/bin/activate +python3.11 -m pip install -r requirements.txt ``` -2. Установка зависимостей: - -```bash -pip install -r requirements.txt -``` - - -3. Создание локального конфига: +3. Создай `.env` по примеру: ```bash cp .env.example .env ``` -4. Заполнение `.env`: +4. Заполни минимум: ```env -BOT_TOKEN=123456:telegram_bot_token -BOT_ADMIN_IDS=123456789 -BOT_DATABASE_EXPORT=False +BOT_TOKEN= +BOT_ADMIN_IDS= ``` -`BOT_ADMIN_IDS` можно указать через запятую: `123456789,987654321`. +Конфигурация читается только из `.env` или переменных окружения. -5. Запуск бота: +5. Запусти бота: ```bash -python main.py +python3 main.py ``` ## Настройки