Хакатон Vink чат-бот

Задача:

создание MVP backend чат-бота с технологией GPT для интеграции на сайт компании для предоставления консультаций по материалам и оборудованию, а также оказания помощи клиентам 24/7.

Общие возможности приложения:

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

Использованные технологии:

Как настроить проект для запуска:

• Установите Docker
• в выбранной для проекта директории разместите файл docker-compose.yml
• Там же создайте файл .env на основе .env.examlpe:

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

• В директории проекта выполните:

docker compose up

• при отсутствии ошибок можно остановить работу через ^C и запустить в фоновом режиме, используя флаг -d:

docker compose up -d

• после чего можно создать суперюзера для доступа к адимин-зоне сайта, выполнив

docker compose exec -it backend python manage.py createsuperuser

вход в админ-зону по эндпоинту /admin

выбрав добавить Bot YGPT - назначьте имя ассистенту, и заполните необходимые поля для доступа к модели

в разделе Project settings выберите дежурного бота, обязательно сохранив изменения

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

После запуска сервера доступна по следующим эндпоинтам:

• api/swagger/ - Swagger API description
• api/redoc/ - Redoc API description
• api/doc/ - OpenAPI specification yaml-file download

Установка локально

• Клонируйте репозиторий и перейдите в него в командной строке:

git clone https://github.com/hakaton-vink-furious-six-team/vink-backend.git

cd vink-backend/

• Создайте виртуальное окружение и установите файл с зависимостями:

py -3.10 -m venv venv
source venv/Scripts/activate
pip install -r requirements.txt

• На основе .env.example создайте файл .env нужно иметь готовую к подключению базу PosgreSQL или указать другие настройки в DATABASES файла config\settings.py

• создайте и примените миграции

python manage.py makemigrations
python manage.py migrate

• запустите сервер

python manage.py runserver

---

Наша команда разработчиков:

- Владимир Шевченко 🛒

- Тимофей Карпов 🛒