Files
PrimoWorldsBot/Documentation/README.md

75 lines
3.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
## PRIMO_aiogram_bot
---
## Приветствие
Здравствуй, <u>**дорогой пользователь**</u>!
Меня зовут *Лейн*, я думаю, мы вряд ли с Вами знакомы,
но это и неважно.
Этот проект нужен для того, чтобы каждый мог
создать своего *бота* на основе **Aiogram**.
Этот **шаблон** позволит Вам получить все возможные функции: от создания *клавиатур*,
до *логгеров* или *машины состояний*.
---
## Навигация:
- ### [Приветствие](#Приветствие)
- ### [Первый запуск бота](#Запуск)
- ### [Его возможности](#Возможности)
- ### [Прочее](#Прочее)
- ### [Задачи:](#Задачи)
- ### [Прощание](#Прощание)
---
## Запуск
Так что, давайте поговорим немного о самом проекте.
Для начала, проект, что Вы получили с **GitHub**, имеет небольшую особенность
для Windows-пользователей, а именно файл **project.bat**.
Активировав этот файл через *консоль* с помощью команды:
**start project**.
Вы сможете установить локальное окружение, обновить библиотеки и запустить бота. Вам
не понадобиться думать и настраивать бота. Все, что Вам необходимо - это иметь
установленным **Python 3.13** и **GIT**. После этого он автоматически:
- создаст локальное окружение
- установит все необходимые библиотеки
- создаст локальный **GIT** репозиторий
- запустит сам **main.py** (*основной файл бота*)
---
## Возможности
Поэтому, Вы уже получите возможность пользоваться системой **GIT**. Также из плюсов можно
выделить многое другое, например:
- Работа с репозиториями и системой GIT
- Удобное логирование с помощью loguru
- Проверка на ошибки и удобный вывод их в окно консоли
- Работа с базами данных (в разработке)
- И т.д...
---
## Задачи:
- Сделать адекватную базу данных
- Сделать проверки на ошибки, и не правильный тип данных,
а главное, чтобы это логгировалось консолью
- Сделать отдельный логгер под ошибки в файл
- Скачивание аватарок каналов + доделать для чатов
- Доделать команды /ban, /kik, /mute
- И т.д.
---
## Прощание
Я очень рад, что Вы пользуетесь этим проектом, надеюсь,
что в дальнейшем буду улучшать его все дальше и дальше.
Удачи Вам, и ,конечно же...
***Вперед за Истиной, Дорогой Друг!***
-&nbsp;**Verum.**