tatarinovst2 / resting-place-bot

Resting place bot

Общая информация

Если вы хотите найти место для отдыха в одном из самых живописных городов России - Нижнем Новгороде, вы можете воспользоваться нашим чат-ботом в Telegram. Он имеет следующие особенности:

1. В боте существует несколько категорий на выбор для вашего времяпровождения: Рестораны, Кофейни, Бары, Кино, Музеи, Театры, Фестивали, Концерты.
2. Для каждого места бот содержит следующую информацию: название, адрес, веб-сайт, средний чек, часы работы, номер телефона, рейтинг.
3. Бот может найти места, отсортированные по его рейтингу, через категории.
4. Бот может найти конкретное место необходимое пользователю через поиск по названию или адресу.
5. В боте пользователь может оценить посещенное место.
6. В боте пользователь может добавить место в Избранное.
7. В боте пользователь может отметить место как посещенное, а также просмотреть списки посещенных и непосещенных мест.

Описываемый ниже функционал представляет собой пользовательскую документацию.
Техническую документацию можно найти здесь.

Запуск бота

1. Запустите командную строку или терминал.
2. Перейдите в директорию с помощью команды cd путь к проекту.
3. Введите в командной строке python3 -m pip install -r requirements.txt, чтобы установить зависимости.
4. Запустите бота с помощью команды python3 main.py.

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

1. Откройте приложение Telegram на вашем устройстве.
2. В поле Поиск введите resting_place_bot.
3. Введите команду /start.

Поиск по категории

Перед выполнением следующих шагов обратитесь к процедуре Начало работы с ботом.

1. Нажмите на кнопку Категории.
2. Выберите одну из предложенных категорий, нажав на одну из следующих кнопок: Еда, Кино, Музеи и театры, Фестивали и концерты.
3. Выберите необходимую подкатегорию:
   1. Если в предыдущем шаге вы нажали на кнопку Еда, то нажмите на одну из следующих кнопок Ресторан, Кофейня, Бар.
   2. Если в предыдущем шаге вы нажали на кнопку Музеи и театры, то нажмите на одну из следующих кнопок Музей, Театр.
   3. Если в предыдущем шаге вы нажали на кнопку Фестивали и концерты, то нажмите на одну из следующих кнопок Фестиваль, Концерт.

Бот выдаст 5 мест, отсортированных по их рейтингу. Чтобы увидеть больше, нажмите на кнопку Показать больше.

Поиск по названию или адресу

Перед выполнением следующих шагов обратитесь к процедуре Начало работы с ботом.

1. Нажмите на кнопку Поиск.
2. Введите место, которое хотите найти.
   Вы можете ввести адрес необходимого места или первую букву его названия, а бот выведет найденные результаты.

Оценка места

Перед выполнением следующих шагов обратитесь к процедуре Начало работы с ботом.

1. Нажмите на кнопку Поиск.
2. Введите необходимое место.
   Вы также можете осуществить поиск места, обратившись к процедуре Поиск по категории.
3. Нажмите на кнопку Оценить.
4. Выберите одну из предложенных оценок, нажав на одну из следующих кнопок: 1, 2, 3, 4, 5.

Избранное

Перед выполнением каждого из следующих действий обратитесь к процедуре Начало работы с ботом.

Добавление места в Избранное

1. Нажмите на кнопку Поиск.
2. Введите необходимое место.
   Вы также можете осуществить поиск места, обратившись к процедуре Поиск по категории.
3. Нажмите на кнопку Добавить в избранное.
   

Просмотр мест в Избранном

1. Нажмите на кнопку Избранное.
   Вы можете вернуться к кнопке Избранное в любой момент, нажав на кнопку В начало.

Удаление места из Избранного

1. Нажмите на кнопку Поиск.
2. Введите необходимое место.
   Вы также можете осуществить поиск места, обратившись к процедуре Поиск по категории.
3. Нажмите на кнопку Удалить из избранного.
   

Посещенное

Перед выполнением каждого из следующих действий обратитесь к процедуре Запуск бота.

Отметить место как посещенное

1. Нажмите на кнопку Поиск.
2. Введите необходимое место.
   Вы также можете осуществить поиск места, обратившись к процедуре Поиск по категории.
3. Нажмите на кнопку Отметить как посещенное.
   

Просмотр посещенных мест

1. Нажмите на кнопку Посещенные места.
   Вы можете вернуться к кнопке Посещенные места в любой момент, нажав на кнопку В начало.

Просмотр непосещенных мест

1. Нажмите на кнопку Непосещенные места.
   Вы можете вернуться к кнопке Непосещенные места в любой момент, нажав на кнопку В начало.

Отметить место как непосещенное

1. Нажмите на кнопку Поиск.
2. Введите необходимое место.
   Вы также можете осуществить поиск места, обратившись к процедуре Поиск по категории.
3. Нажмите на кнопку Убрать из посещенных.
   

Завершение работы

Чтобы завершить работу с ботом введите команду /stop.