diff --git a/README.md b/README.md index 25b3c12..661fb6a 100644 --- a/README.md +++ b/README.md @@ -1,110 +1,83 @@ -# Bot_of_Pray -Telegram-бот для молитвенного поминания -Описание проекта - +# Telegram-бот для молитвенного поминания +## Описание проекта Бот предоставляет пользователям возможность отправлять имена для молитвенного поминания священнику. Система позволяет добавлять имена в разные типы записок, оставлять комментарии и управлять своими записями. -Основные функции +## Основные функции - Типы записок: +### Типы записок: +* О здравии +* За упокой +* Комментарии - О здравии +### Управление записями: +* Просмотр текущих записей +* Добавление новых имен +* Очистка записей +* Сохранение изменений - За упокой +###Админ-панель: +* Получение уведомлений о новых записях +* Статистика использования +* Управление записями - Комментарии +## Архитектура проекта - Управление записями: +### Структура папок: +* handlers/ - обработчики команд и callback-запросов +* utils/ - вспомогательные функции +* messages.py - текстовые сообщения +* main.py - точка входа приложения +* prefixes.json - файл с префиксами +* requirements.txt - зависимости проекта - Просмотр текущих записей +## Основные компоненты - Добавление новых имен +### Обработчики: +* Пользовательские команды +* Callback-запросы +* Админ-команды +* Базовые функции +* Утилиты: +* Работа с базой данных - Очистка записей +### Форматирование сообщений +* Отправка уведомлений +* Логирование - Сохранение изменений +## Требования и установка - Админ-панель: +###Необходимые зависимости: - Получение уведомлений о новых записях +* Python 3.8+ +* Python-telegram-bot +* Дополнительные библиотеки из requirements.txt - Статистика использования - - Управление записями - -Архитектура проекта - - Структура папок: - - handlers/ - обработчики команд и callback-запросов - - utils/ - вспомогательные функции - - messages.py - текстовые сообщения - - main.py - точка входа приложения - - prefixes.json - файл с префиксами - - requirements.txt - зависимости проекта - -Основные компоненты - - Обработчики: - - Пользовательские команды - - Callback-запросы - - Админ-команды - - Базовые функции - - Утилиты: - - Работа с базой данных - - Форматирование сообщений - - Отправка уведомлений - - Логирование - -Требования и установка - - Необходимые зависимости: - - Python 3.8+ - - Python-telegram-bot - - Дополнительные библиотеки из requirements.txt - -Настройка и запуск - - Настройка окружения: - - Создайте файл .env с необходимыми переменными: +## Настройка и запуск +### Настройка окружения: +* Создайте файл .env с необходимыми переменными: +```bash TELEGRAM_TOKEN_FILE=path/to/token.txt TELEGRAM_DATABASE=path/to/database.json TELEGRAM_ADMINS=path/to/admins.txt +``` -Установка зависимостей: - +###Установка зависимостей: +```bash pip install -r requirements.txt - -Запуск бота: - +``` +###Запуск бота: +``` bash python main.py +``` -Структура данных +##Структура данных - База данных: +**База данных: ** Хранится в формате JSON - Структура: - +### Структура: +``` { "user_id": { "О здравии": ["имя1", "имя2"], @@ -112,18 +85,15 @@ pip install -r requirements.txt "Комментарий": "текст комментария" } } +``` +##Развертывание -Развертывание +### Рекомендации: - Рекомендации: - - Используйте Docker для деплоя - - Настройте мониторинг состояния бота - - Добавьте систему автоматического перезапуска - - Обеспечьте регулярное резервное копирование данных +* Используйте Docker для деплоя +* Настройте мониторинг состояния бота +* Добавьте систему автоматического перезапуска +* Обеспечьте регулярное резервное копирование данных Поддержка и развитие