Проект, разработан в рамках академической программы GPB IT FACTORY 2024, представляет собой практическое приложение на Java, демонстрирующее систему "МиниБанк". Он состоит из трех основных компонентов: фронтенд в виде Telegram-бота, миддлваре-сервис на Java и бэкенд-сервис на Java. Проект создан с учетом современных мировых стандартов и включает в себя Java 21, Spring Boot, PostgreSQL, Docker и Kubernetes.
Для запуска проекта Вам необходимо установить следующий компоненты:
Для удобства запуск бота предусмотрен в Docker контейнере, запускаемом Docker-compose приложением.
- Клонируйте проект
git clone https://github.com/gpb-it-factory/semkin-telegram-bot.git
- Войдите в директорию с проектом cd /путь/к/проекту/
- Разрешите выполнение скриптов
sudo chmod +x start-bot.sh && chmod +x stop-bot.sh
- Создайте в директории /Docker файл telegram-bot.env.
- Добавьте в файл telegram-bot.env переменную TELEGRAM_GPB_BOT_TOKEN: ТОКЕН-БОТА.
- Выполните скрипт
./start-bot.sh
для запуска бота. - Выполните скрипт
./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
Ссылки на дополнительные ресурсы и документацию, если они есть.
Если у вас есть вопросы или предложения, вы можете связаться со мной следующим образом:
- Email: vnsemkin@gmail.com
- Telegram: @vnsemkin