/elenberger-telergam-bot

Чат-бот для телеграмм

Primary LanguageJava

"Мини-банк" чат-бот для Telegram

Создано в рамках обучения в академии Backend-разработки GPB IT Factory

Оглавление

  1. О проекте
  2. Начало работы
  3. Необходимые компоненты
  4. Скачивание и установка
  5. Используемые команды и примеры
  6. Контакты
  7. To Do

О проекте

Данный проект представляет собой часть банковского приложения
Telegram-бот — это Frontend часть "мини-банка", инициализирующая запросы пользователя для работы с Backend, посредством определенного списка команд
Полная схема "мини-банка":

@startuml
!theme spacelab
actor "Пользователь" as User
participant "Frontend" as Front
participant Middle
participant "Backend" as Back
rnote over of Front: Телеграмм-бот\nВыполняет роль клиентского приложения\nИнициализирует запросы пользователя
/ rnote over of Middle: Сервис на Java\nПринимает запросы бота\nПроводит валидацию\nВыполняет бизнес-логику\nМаршрутизирует запросы в "банк"
/ rnote over of Back: Выступает в качестве АБС\nОбрабатывает транзакции\nХранит клиентские данные
User -> Front : Обращается к боту
activate Front
Front -> Middle : Инициализация запроса
activate Middle
Middle -> Back : Маршрутизация запроса в "банк"
activate Back
Back -> Back : Сохранение изменений
Back --> Middle : Возвращение данных
deactivate Back
Middle --> Front : Возвращение ответного запроса
deactivate Middle
Front --> User : Вывод ответного сообщения
deactivate Front
@enduml

Вверх ⬆️

Начало работы

⚠️ Раздел в разработке

Для начала работы убедитесь в наличии установленной Java версии 17+ и Git
Для работы данного проекта необходимо зарегистрировать своего бота. Сделать это вы можете найдя в телеграмме @BotFather.
Получив ток и имя своего бота, приступайте к установке.

Вверх ⬆️

Необходимые компоненты

⚠️ Новые компоненты будут добавляться по мере развития проекта

Вверх ⬆️

Скачивание и установка

⚠️ Раздел в разработке
Для скачивания репозитория используйте в PowerShell команду: git clone https://github.com/gpb-it-factory/elenberger-telergam-bot
Далее установите переменные окружения. Для этого откройте свойства вашего компьютера. Перейдите в меню "Advanced System Settings" и нажмите кнопку "Enviroment Variables"
Для корректной работы бота необходимо создать переменную
TELEGRAM_BOT_NAME, которая содержит имя вашего бота
и TELEGRAM_BOT_TOKEN, которая содержит токен вашего бота.
Для запуска приложения в PowerShell перейдите в каталог со склонированным репозиторием и используйте команду: ./gradlew bootRun

Вверх ⬆️

Используемые команды и примеры

⚠️ Будут добавляться по мере развития функционала
В данный момент доступны команды:
/start - начинает работу с ботом
/ping - дает в ответ pong
/help - команда в разработке, выводит список доступных действий
/register - регистрация пользователя в системе мини-банка

Вверх ⬆️

Контакты

E-mail: elnberg2397@gmail.com
Telegram: LohmatiyShmel

Вверх ⬆️

To Do

Учет текущих задач по проекту

  • Задача 1. Создать репозиторий для telegram-бота
  • Задача 2. Добавить ReadMe
  • Задача 3. Создать "скелет" бота
  • Задача 4. Реализовать команду регистрации
  • Задача 5. Реализовать команду создания счета
  • Задача 6. Реализовать команду запроса баланса
  • Задача 7. Реализовать команду перевода средств
  • .... TBD

Вверх ⬆️