Skills

Cервис Яндекс Практикума “Трекер развития”, позволяющего строить план обучения от точки А до точки Б.

Содержание

1. Cведения о команде

2. Cсылка на веб хостинг

3. Подготовка к запуску

   3.1. Правила работы с git

   3.2. Настройка переменных окружения

   3.3. Запуск сервера локально

4. Cтэк технологий

5. Cсылки на сторонние библиотеки

1. Cведения о команде:

1. Разработчик Ярослав Андреев
2. Разработчик Natalia Arlazarova

2. Cсылка на веб хостинг

• Авторизация по yandex id
• Сервис Skills
• Swagger

3. Подготовка к запуску

Примечание: использование Docker, poetry.

3.1. Правила работы с git (как делать коммиты и pull request-ы):

1. Две основные ветки: main и develop
2. Ветка develop — “предрелизная”. Т.е. здесь должен быть рабочий и выверенный код
3. Создавая новую ветку, наследуйтесь от ветки develop
4. В main находится только production-ready код (CI/CD)
5. Правила именования веток
   • весь новый функционал — feature/название-функционала
   • исправление ошибок — bugfix/название-багфикса
6. Пушим свою ветку в репозиторий и открываем Pull Request

3.2. Настройка переменных окружения

Перед запуском проекта необходимо создать копию файла .env.example, назвав его .env и установить значение базы данных почты и тд.

Системные требования

• Python 3.11+;
• Docker (19.03.0+) c docker compose;
• Poetry;

Установка зависимостей poetry:

poetry install

3.3. Запуск сервера локально

Перед тем как запускать сервер локально, нужно подменить url на frontend части, чтобы отображались страницы. Для этого нужно перейти по папкам hackathon/scr/utils/Api.js и в самом конце файла вставить url вместо имеющегося:

baseUrl: 'http://localhost/api/v1'

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

запуск сервиса:

make server-init

остановка сервиса:

make stop

остановка контейнера сервиса:

make clear

4 Cтэк технологий

5 Cторонние библиотеки