/semkin-telegram-bot

Репозиторий предназначен для разработки и сопровождения Telegram-бота как фронтенд-части в рамках проекта "Мини-банк

Primary LanguageJava

GPB IT FACTORY logo

Telegram Чат-бот "МиниБанк"

Проект, разработан в рамках академической программы GPB IT FACTORY 2024, представляет собой практическое приложение на Java, демонстрирующее систему "МиниБанк". Он состоит из трех основных компонентов: фронтенд в виде Telegram-бота, миддлваре-сервис на Java и бэкенд-сервис на Java. Проект создан с учетом современных мировых стандартов и включает в себя Java 21, Spring Boot, PostgreSQL, Docker и Kubernetes.


📝 Содержание

📢 Предварительные требования

Для запуска проекта Вам необходимо установить следующий компоненты:

  1. Java 21
  2. Docker

🚀 Запуск бота

Для удобства запуск бота предусмотрен в Docker контейнере, запускаемом Docker-compose приложением.

  1. Клонируйте проект git clone https://github.com/gpb-it-factory/semkin-telegram-bot.git
  2. Войдите в директорию с проектом cd /путь/к/проекту/
  3. Разрешите выполнение скриптов sudo chmod +x start-bot.sh && chmod +x stop-bot.sh
  4. Создайте в директории /Docker файл telegram-bot.env.
  5. Добавьте в файл telegram-bot.env переменную TELEGRAM_GPB_BOT_TOKEN: ТОКЕН-БОТА.
  6. Выполните скрипт ./start-bot.sh для запуска бота.
  7. Выполните скрипт ./stop-bot.sh для остановки бота.

Адрес бота: https://t.me/gpb_factory_bot

Имя бота: GPB IT Factory Backend 2024

📲 Диаграмма

Смотреть 
@startuml
participant Клиент
participant "Frontend\nTelegram-bot на Java/Kotlin" as Frontend
participant "Middle-слой\nJava/Kotlin-сервис" as Middleware
participant "Backend\nJava/Kotlin-сервис" as Backend

Клиент -> Frontend : Запрос
Frontend -> Middleware : Передача запроса
Middleware -> Backend : Передача запроса
Backend -> Middleware : Ответ
Middleware -> Frontend : Ответ
Frontend -> Клиент : Ответ
@enduml

🔧 Установка

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

Шаги по установке проекта:

git clone https://yourrepository.git
cd your-project-folder
docker-compose up --build

🎯 Использование

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

Примеры того, как использовать проект. Например, как взаимодействовать с ботом через Telegram.

🔍 Тестирование

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

Описание процесса тестирования проекта.

./gradlew test

📚 Документация

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

Ссылки на дополнительные ресурсы и документацию, если они есть.

☎️ Контакты

Если у вас есть вопросы или предложения, вы можете связаться со мной следующим образом: