Skip to content

Studio-Yandex-Practicum/vtoroe_dyhanie

Repository files navigation

workflow pre-commit pre-commit.ci status

vtoroe_dyhanie (Второе дыхание)

Проект телеграм-бота для новых и действующих сотрудников Фонда "Второе дыхание". Помогает автоматизировать HR-процессы и позволяет новым сотрудникам быстрее адаптироваться за счет автоматизации предоставления необходимой информации о работе Фонда.

Задачи бота
  • 1Оптимизация процесса онбординга для новых коллег Фонда "Второе дыхание"
  • Сокращение рабочего времени hr на ответы на одинаковые вопросы коллег
  • Контроль эмоционального состояния коллег
  • Сбор аналитики
Функции бота
  • Предоставление информации о Фонде (общая, ссылка на сайт)
  • Предоставление общей информации о проекте (адрес, директор, оргструктура)
  • Ответы на часто задаваемые вопросы
  • Помощь с документами и формами (присылать документ по выбору из меню)
  • Собирает информацию для аналитики
  • Отложенное отправление напоминаний для конкретных сотрудников
  • Периодический опрос о самочувствии сотрудников
Возможности бота для новых сотрудников
  • Предоставление необходимой информации, ресурсы
  • Ответы на вопросы
  • Кадровые документы
  • Напоминания
Stack
  • Python 3.11
  • Python-telegram-bot 20.5
  • PostgreSQL 16.0
  • Alembic
  • Django 4.2.7
  • Docker
  • Docker-Compose
  • Poetry 1.6.1
Установка и запуск проекта

Клонируйте репозиторий:

git clone git@github.com:Studio-Yandex-Practicum/vtoroe_dyhanie.git

Перейдите в директорию проекта:

cd vtoroe_dyhanie/

Создайте и заполните в ней файл .env - в качестве шаблона используйте файл .env.example

Проект можно запустить как непосредственно в вашей ОС, так и в контейнерах Docker

Для запуска проекта непосредственно в вашей ОС:

Потребуются два терминала для запуска бота и приложения администрации контента и 2 базы данных Postgres.

Инициализируйте создание директории виртуального окружения в проекте:

poetry config virtualenvs.in-project true

Создайте директорию виртуального окружения:

poetry install

Далее вы можете либо запустить виртуальное окружение самостоятельно:

poetry shell

Или воспользовавшись вот такой командой:

source .venv/bin/activate (для UNIX)
source .venv/Scripts/activate (для WINDOWS)

В первом терминале необходимо запустить приложение администрации контента. перейдите в него:

cd src/admindjango_bot

Примените миграции:

python manage.py migrate

Загрузите контент в базу данных приложения:

python manage.py loaddata initial_data.json

Запустите приложение:

python manage.py runserver

Логин / пароль админки, соответственно admin / admin - их лучше поменять

Во втором терминале необходимо запустить приложение бота. Для этого примените миграции для создания структуры БД:

alembic upgrade head

Запустите скрипт наполнения БД информацией о контактах:

python src/contacts_upload.py

Запустите проект локально:

python src/application.py

Для запуска проекта в контейнерах Docker:

Перейдите в директорию infra:

cd infra/

Выполните команду для создания и запуска приложения в контейнерах:

docker-compose up -d --build

Примените миграции для создания структуры БД админки:

docker-compose exec admin_django python3 manage.py migrate

Запустите наполнение БД информацией о константах:

docker-compose exec admin_django python3 manage.py loaddata initial_data.json

Соберите статику приложения в отдельной директории:

docker-compose exec admin_django python3 manage.py collectstatic

Примените миграции для создания структуры БД бота:

docker-compose exec tg_bot_second_wind alembic upgrade head

Запустите скрипт наполнения БД информацией о контактах:

docker-compose exec tg_bot_second_wind python3 src/contacts_upload.py
Команда разработки

Тимлид:

Проджект менеджер:

Разработчики:

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages