README.md

Микросервис Индивидуальных планов развития сотрудников Альфа банка

Сервис, в рамках которого для сотрудников можно будет составить ИПР (индивидуальные планы развития), просматривать его и валидировать выполнение целей.

Сведения о команде

Менеджер проекта - отвечает за синхронизацию Команды, выполнение задач в дедлайны Конкурса и организационные вопросы:
Андрей Нестеров https://t.me/Agarhim

Product-менеджер – делает: анализ ЦА, прописывает цели, задачи проекта, гипотезы, юзерфлоу (как ни странно, неправда ли), юзерстори, портрет пользователя, рисует макет MVP:
Вероника Кусакина https://t.me/kuvero

SA – отвечает за технические требования:
Евгения Новак https://t.me/jane_nova
Александр Добаков https://t.me/dabakov

BA – отвечает за бизнес требования:
Лариса Фишер https://t.me/FisherLarisa
Елизавета http://t.me/L_t71

Дизайнер — креативщик Команды, отвечает за UI/UX, дизайн макетов:
Серж https://t.me/BugsBunny313
Марина Титова https://t.me/marinatitova17

Frontend-разработчик – отвечает за визуализацию данных:
Максим Бучков https://t.me/popavsi
Павел Захаров https://t.me/pz1776
Алексей Тютрин https://t.me/tuxoneee

Backend-разработчик – отвечает за обработку данных:
Павел Ложкин https://t.me/lozhkin_pa
Александр Струнский https://t.me/alexstrunskiy
Максим Спицын https://t.me/maxu_s
Екатерина Новикова https://t.me/moncher_ii

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

https://alfahackathon.hopto.org/api/v1/swagger/

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

https://alfahackathon.hopto.org/api/v1/Redoc/

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

Локальное развертывание

1. Необходимо переименовать файл .env.example и отредактировать переменные
2. Создать локальное окружение:

   python -m venv venv
   

3. Запустить локальное окружение

   . venv/bin/activate
   

4. Установить зависимости:

    pip install -r requirements.txt
   

5. Необходимо в файле ipr/ipr/settings.py закоментировать строку CSRF_TRUSTED_ORIGINS = ['https://alfahackathon.hopto.org']
6. Запустить БД в контейнере:

docker compose -f docker-compose-local.yml up -d

7. Запустить сервис разработчика:

  python manage.py runserver

Развертывание на сервере.

1. Поменять в следующих файлах название домена на небходимое (сейчас alfahackathon.hopto.org):

• init-letsencrypt.sh
• dockerization/nginx/default.conf
• ipr/ipr/settings.py

2. Запустить файл init-letsencrypt.sh
3. Запустить Docker Compose

docker compose up -d

Тестирование

Тестирование производится командой:

python manage.py test

Покрытие тестами около 70%

Стэк технологий