Премиум Продукт

Удобный Telegram-бот для поиска коммерческой недвижимости!
Перейти в Telegram »
Посмотреть видеоинструкцию »

Демо-версия админ-панели · Сообщить об ошибке · Предложить улучшение

Содержание

1. Описание проекта
   • Применяемые технологии
2. Запуск проекта
   • Локально
   • На удалённом сервере
3. Использование бота
   • Функционал для пользователей
   • Функционал для администраторов
   • Функционал для суперадминистраторов
4. Команда разработчиков

---

Описание проекта

Telegram-бот предназначен для упрощения поиска коммерческой недвижимости для аренды или покупки. Бот предоставляет пользователям возможность быстро находить подходящие объекты недвижимости по заданным критериям, а также получать подробную информацию о каждом объекте, контактную информацию владельцев или агентов, и подписываться на уведомления о новых предложениях.

(вернуться наверх)

Применяемые технологии

• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 

(вернуться наверх)

---

Запуск проекта

Локально

Требование к системе: На компьютере должен быть установлен Docker. Проект можно развернуть только в контейнерах. Для того, чтобы Telegram мог работать с Вашим компьютером через механизм webhook, необходимо использовать https-тоннель. Рекомендуем воспользоваться сервисом xTunnel

1. Клонировать репозиторий:

git clone git@github.com:Studio-Yandex-PracticumPremium_product_bot_team_3.git

2. Заполнить переменные окружения в файл .env по образцу .env.example
3. Запустить docker-контейнеры:

docker compose up --build -d

4. Выполнить миграции:

docker compose exec real_estate python manage.py migrate

5. Создать суперпользователя для админ-панели:

docker compose exec -it real_estate python manage.py createsuperuser

6. Скопировать статические файлы:

docker compose exec real_estate python manage.py collectstatic --no-input

7. Загрузить тестовые данные в базу (при необходимости)

docker compose exec real_estate python manage.py upload_objects --file example_data.csv

8. Зайти в админ-панель по адресу http://localhost:8000/admin/ и загрузить изображение для логотипа. Изображение будет использоваться для тех случаев, когда объявление не содержит фото объекта недвижимости. Загружать можно в любое объявление, но имя файла должно быть logo_v3.jpg
9. После этих действий можно зайти в бота через Telegram и протестировать его работу

На удалённом сервере

Требование в серверу: На сервере под управлением ОС Linux должна быть проведена первичная настройка. Необходимо установить и настроить nginx так, чтобы запросы на Ваш домен перенаправлялись в папку с проектом. Кроме того, на сервере должен быть установлен Docker. Для домена нужно получить SSL-сертификат. Это позволит использовать его в качестве сервера для webhook.

1. Клонировать репозиторий:

git clone git@github.com:Studio-Yandex-PracticumPremium_product_bot_team_3.git

2. Заполнить переменные окружения в файл .env по образцу .env.example
3. Выполнить в контейнере те же операции, что и локально:

docker compose -f docker-compose.production.yml pull
docker compose -f docker-compose.production.yml up -d
docker compose -f docker-compose.production.yml exec real_estate python manage.py migrate
docker compose -f docker-compose.production.yml exec -it real_estate python manage.py createsuperuser
docker compose -f docker-compose.production.yml exec real_estate python manage.py collectstatic --no-input
docker compose -f docker-compose.production.yml exec real_estate python manage.py upload_objects --file example_data.csv

4. После этих действий можно зайти в бота через Telegram и протестировать его работу

(вернуться наверх)

---

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

Функционал для пользователей

1. Поиск объектов недвижимости:
   • Поиск по городам (например, Москва, Санкт-Петербург, Казань и т.д.).
   • Поиск по категориям (офисы, склады, магазины и т.д.).
   • Фильтры поиска по цене, площади, типу ремонта, наличию парковки и другим параметрам.
   • Сортировка результатов поиска по цене, площади, дате публикации.
   • Сохранение объектов в избранное.
   • Подписка на уведомления о новых объектах, соответствующих критериям поиска пользователя.
2. Просмотр информации об объектах:
   • Возможность отправить запрос на просмотр объекта.
   • Возможность оставить текстовый отзыв об объекте (отзывы модерируются администратором).
   • Возможность добавлять объект в избранное.
3. Сохранение истории пользователя в случае его удаления из бота:
   • В течение 30 дней удалённый пользователь может восстановиться в боте с сохранением параметров поиска, избранного и отзывов.
4. Общение и поддержка:
   • Получение инструкций по работе с ботом.

Функционал для администраторов

1. Управление объявлениями:
   • Добавление и изменение объявлений.
   • Модерация и удаление объявлений (удаленные объявления помечаются как "Удалено администратором").
   • Управление типами объектов недвижимости.
2. Управление пользователями:
   • Блокировка, разблокировка и редактирование пользователей.
   • Удаление пользователей и их данных.
3. Модерация отзывов:
   • Модерация и удаление отзывов к объектам недвижимости.

Функционал для суперадминистраторов

1. Все функции обычных администраторов.
2. Настройка администраторов:
   • Назначение и удаление обычных администраторов.

📺 Более подробную информацию по использованию бота Вы можете получить в Видеоинструкции 📺

(вернуться наверх)

---

Команда разработчиков

Алексей Данилов

Занимался управлением командой (TeamLead):

• декомпозиция и распределение задач,
• ежедневная проверка отчётов,
• проведение ревью и тестирование,
• помощь команде в проблемных задачах.

Софья Боровкова

Занималась функционалом бота, админ-панели и стандартизацией кода:

• разработка функционала добавления в избранное,
• контактная информация в боте,
• оформление админ-панели,
• оформление кода согласно PEP8,
• помощь коллегам в проблемных задачах.

Андрей Щапов

Занимался логикой поиска бота и функционалом рассылки:

• разработка логики поиска объектов,
• разработка функционала рассылки,
• помощь коллегам в проблемных задачах.

Дарья Семенова

Занималась функционалом бота и первичной документацией:

• разработка функционала отзывов,
• график работы для объектов недвижимости,
• разработка первичной документации бота,
• помощь коллегам в проблемных задачах.

Павел Найденов

Занимался созданием экосистемы бота, контейнеризацией, деплоем, документацией и презентацией:

• разработка первоначальной структуры асинхронного бота, работающего совместно с Django через механизм webhook-ов,
• упаковка проекта в контейнеры при соблюдении условия использования облегчённых версий основных пакетов,
• написание сценариев автоматизации сборки и деплоя проекта,
• работа по настройке сервера
• приведение первичной документации к более подробному виду, разработка видеопрезентации,
• помощь коллегам в проблемных задачах.

(вернуться наверх)