AlfaBankHackathon



Документация к API будет доступна по url-адресу AlfaBankHackathon/SWAGER

Ссылка на zip-архив с некоторыми скриншотами zip

Сервис по развитию сотрудников

  • MVP:

    • Цель: Организация работы по развитию сотрудников IT-департамента в рамках Индивидуального плана развития (ИПР).
    • Размещение: Внутри корпоративного портала Альфа-банка "Alfa People".
  • Функциональные возможности:

    • Создание и управление ИПР.
    • Постановка целей и задач.
    • Планирование сроков выполнения.
    • Отслеживание выполнения задач.
  • Обучение:

    • Отслеживание прогресса обучения.
    • Получение обратной связи.
    • Аналитика по ИПР.
    • Систематизация работы по развитию сотрудников.
  • Преимущества:

    • Индивидуальные планы развития для каждого сотрудника.
    • Отслеживание прогресса развития.
    • Автоматизация рутинных процессов.
  • Целевая аудитория:

    • Сотрудники IT-департамента Альфа-банка.
    • Руководители IT-департамента.

Инструкция по установке

Клонируйте репозиторий и перейдите в него.

git@github.com:ThatCoderMan/AlfaBankHackathon.git

Для установки виртуального окружения с помощью Poetry нужно установить его через pip:

pip install poetry

Для активации poetry нужно прописать:

poetry install

Работа с зависимостями

Обновления зависимостей (при загрузки обновлений репозитория с GitHub):

poetry update

Создайте файл .env, в корневой папке проекта, с переменными окружения.

APP_TITLE=AlfaBankHackathon
DESCRIPTION=AlfaBankHackathon
SECRET=SECRET
DATABASE_URL=postgresql+asyncpg://postgres:postgres@localhost:5432/postgres

MAIL_USERNAME=your_username
MAIL_PASSWORD=mail_password
MAIL_FROM=example@mail.com
MAIL_PORT=465
MAIL_SERVER=smtp

Находясь в корневой папке проекта выполните миграции.

alembic revision --autogenerate -m "Initial migration"
alembic upgrade head

Для запуска сервера используйте данную команду:

uvicorn app.main:app --reload

Запуск проекта через докер

  • Клонируйте репозиторий.
  • Перейдите в папку infra и создайте в ней файл .env с переменными окружения:
    DB_NAME=postgres
    POSTGRES_USER=postgres
    DB_HOST=db
    DB_PORT=5432
    POSTGRES_PASSWORD=password
    CORS_ORIGINS=http://localhost:3000,http://127.0.0.1:3000
    PGADMIN_DEFAULT_EMAIL=user@gmail.ru
    PGADMIN_DEFAULT_PASSWORD=user_password
    
  • Из папки infra запустите docker-compose-prod.yaml:
    ~$ docker-compose up -d --build
    
  • В контейнере backend выполните миграции:
    ~$ docker-compose exec backend alembic revision --autogenerate -m "Initial migration"
    
    ~$ docker-compose exec backend alembic upgrade head
    

Документация к API будет доступна по url-адресу 127.0.0.1/redoc

Ссылки на используемые библиотеки