This commit is contained in:
2025-11-16 12:36:02 +09:00
parent 3a25e6a4cb
commit eb3f3807fd
61 changed files with 1438 additions and 1139 deletions

89
docs/QUICKSTART.md Normal file
View File

@@ -0,0 +1,89 @@
````markdown
# Быстрый старт
## 1. Создание бота в Telegram
1. Найдите @BotFather в Telegram
2. Отправьте команду `/newbot`
3. Следуйте инструкциям для создания бота
4. Сохраните полученный токен
## 2. Получение вашего Telegram ID
1. Найдите @userinfobot в Telegram
2. Отправьте команду `/start`
3. Запишите ваш ID (число)
## 3. Настройка проекта
```bash
# Копируйте файл конфигурации
cp .env.example .env
# Отредактируйте .env файл, заполнив:
# BOT_TOKEN=ваш_токен_от_BotFather
# ADMIN_IDS=ваш_telegram_id
```
## 4. Быстрый запуск
```bash
# Автоматический запуск (рекомендуется)
./start.sh
# Или ручная установка:
pip install -r requirements.txt
python utils.py init
python utils.py setup-admins
python main.py
```
## 5. Тестирование
```bash
# Создать тестовый розыгрыш
python utils.py sample
# Посмотреть статистику
python utils.py stats
```
## 6. Использование бота
1. Найдите вашего бота в Telegram по имени
2. Отправьте `/start`
3. Используйте кнопки меню для навигации
### Как провести розыгрыш:
1. **Создайте розыгрыш** (только админы)
- Нажмите " Создать розыгрыш"
- Введите название, описание и призы
2. **Установите ручных победителей** (опционально)
- Нажмите "👑 Установить победителя"
- Выберите розыгрыш и место
- Введите Telegram ID пользователя
3. **Дождитесь участников**
- Участники нажимают "🎫 Участвовать"
4. **Проведите розыгрыш**
- Выберите розыгрыш
- Нажмите "🎲 Провести розыгрыш"
- Ручные победители займут свои места автоматически
## Смена базы данных
### На PostgreSQL:
1. Установите PostgreSQL
2. Создайте базу данных
3. В .env измените:
```env
DATABASE_URL=postgresql+asyncpg://username:password@localhost/lottery_bot_db
```
4. Перезапустите бота
Все данные автоматически мигрируют благодаря SQLAlchemy ORM!
````