Skip to content

README.md

Latest commit

 

History

History
74 lines (60 loc) · 4.17 KB

README.md

File metadata and controls

74 lines (60 loc) · 4.17 KB

WishlistBot

WishlistBot — это Telegram бот, позволяющий пользователям выбирать и отслеживать желаемые подарки. Администратор может управлять списком подарков, добавлять новые, а также отправлять сообщения пользователям. Посмотреть функционирующуя версию: https://t.me/LetaatHBBot

Функциональные возможности

Для пользователей:

  1. /start — начать работу с ботом.
  2. /gifts — просмотреть доступные категории подарков. Пользователь может выбрать категорию и увидеть список подарков, которые можно выбрать.
  3. /mygifts — просмотреть подарки, которые пользователь уже выбрал. Эти подарки больше не доступны для других пользователей.
  4. Выбор подарка — после выбора категории, пользователь может увидеть список подарков и выбрать один, который больше не будет отображаться для других пользователей.

Для администратора:

  1. /add — добавить новый подарок. Формат: /add название!описание!категория. Идентификатор подарка присваивается автоматически.
  2. /delete — удалить подарок. Формат: /delete название.
  3. /send — отправить сообщение всем пользователям.
  4. Добавление картинок — администратор может загружать изображения для подарков, которые будут отправляться вместе с информацией о подарке.

Категории подарков

  1. Мелочи
  2. В районе 1к
  3. Дорого
  4. Капец дорого

Как установить и запустить

Локальный запуск:

  1. Клонируйте репозиторий: 
    git clone https://github.com/LetaTreiden/WishlistBot.git
  2. Соберите проект с использованием Maven: 
    mvn clean install
  3. Запустите бота: 
    mvn exec:java -Dexec.mainClass="ru.treiden.Wishlist.Main"

Запуск на сервере:

  1. Убедитесь, что на сервере установлен Java.
  2. Выполните сборку проекта локально, либо скопируйте собранный файл .jar на сервер.
  3. Запустите бот с помощью команды: 
    mvn exec:java -Dexec.mainClass="ru.treiden.Wishlist.Main"

Конфигурация

Бот использует библиотеку TelegramBots для интеграции с Telegram API.

Переменные среды:

  • BOT_USERNAME — имя бота в Telegram.
  • BOT_TOKEN — токен для доступа к API Telegram, который можно получить у BotFather.

Структура данных

Gift

Модель подарка включает:

  • id (автоматически присваиваемый уникальный идентификатор),
  • name (название подарка),
  • description (описание),
  • category (категория подарка).

Category

Перечисление категорий подарков:

  • small — Мелочи,
  • 1k — В районе 1к,
  • exp — Дорого,
  • super_exp — Капец дорого.

Лицензия

Этот проект распространяется под лицензией MIT. См. файл LICENSE для подробностей.