Edit README.md
This commit is contained in:
parent
b447389479
commit
634a9dfc9d
47
README.md
47
README.md
@ -50,9 +50,30 @@
|
||||
* Python 3.8+
|
||||
* Python-telegram-bot
|
||||
* Дополнительные библиотеки из requirements.txt
|
||||
Настройка и запуск
|
||||
|
||||
## Настройка и запуск
|
||||
|
||||
###Контейнеризация проекта
|
||||
|
||||
Проект реализован с использованием Docker Compose. Конфигурация описана в файле docker-compose.yaml:
|
||||
```yaml
|
||||
services:
|
||||
telegram-bot:
|
||||
image: python
|
||||
volumes:
|
||||
- ./python-bot:/usr/src/app
|
||||
- ./secrets:/usr/src/app/secrets
|
||||
- ./requirements.txt:/usr/src/app/requirements.txt
|
||||
working_dir: /usr/src/app
|
||||
command: python main.py
|
||||
environment:
|
||||
- TELEGRAM_TOKEN_FILE=/usr/src/app/secrets/token.txt
|
||||
- TELEGRAM_DATABASE=/usr/src/app/data.json
|
||||
- TELEGRAM_ADMINS=/usr/src/app/secrets/admins.txt
|
||||
entrypoint: ["sh", "-c", "export PIP_ROOT_USER_ACTION=ignore && pip install -r /usr/src/app/requirements.txt && pip install --upgrade pip && python main.py"]
|
||||
```
|
||||
|
||||
### Настройка окружения:
|
||||
* Создайте файл .env с необходимыми переменными:
|
||||
```bash
|
||||
@ -72,7 +93,7 @@ pip install -r requirements.txt
|
||||
|
||||
## Структура данных
|
||||
|
||||
**База данных: **
|
||||
### База данных:
|
||||
|
||||
Хранится в формате JSON
|
||||
|
||||
@ -95,35 +116,35 @@ pip install -r requirements.txt
|
||||
* Добавьте систему автоматического перезапуска
|
||||
* Обеспечьте регулярное резервное копирование данных
|
||||
|
||||
Поддержка и развитие
|
||||
## Поддержка и развитие
|
||||
|
||||
Документация:
|
||||
### Документация:
|
||||
|
||||
Все основные функции документированы в коде
|
||||
|
||||
Добавлены комментарии к критическим участкам
|
||||
|
||||
Тестирование:
|
||||
### Тестирование:
|
||||
|
||||
Реализовано базовое логирование ошибок
|
||||
|
||||
Добавлены проверки корректности данных
|
||||
|
||||
Контактная информация
|
||||
## Контактная информация
|
||||
|
||||
Поддержка:
|
||||
### Поддержка:
|
||||
|
||||
Для вопросов и предложений обращайтесь к разработчикам
|
||||
|
||||
Лицензирование
|
||||
## Лицензирование
|
||||
|
||||
Лицензия:
|
||||
|
||||
MIT License
|
||||
GPL3.0
|
||||
|
||||
История изменений
|
||||
## История изменений
|
||||
|
||||
Версия 1.0:
|
||||
### Версия 1.0:
|
||||
|
||||
Базовая функциональность
|
||||
|
||||
@ -133,11 +154,5 @@ pip install -r requirements.txt
|
||||
|
||||
Админ-панель
|
||||
|
||||
Благодарности
|
||||
|
||||
Команда разработчиков:
|
||||
|
||||
Благодарим всех участников проекта за вклад в развитие бота
|
||||
|
||||
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user