Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 4.74 KB

README.md

File metadata and controls

83 lines (56 loc) · 4.74 KB

Правила

Push

Внимательно проверяйте свои коммиты. Push делайте только в свои ветки. Назовите их своим ником. НЕ ДЕЛАЙТЕ PUSH в main/master!

Сообщения в коммитах ///МАСШТАБНОЕ ИЗМЕНЕНИЕ СИСТЕМЫ ВЕРСИОНИРОВАНИЯ///

Начиная с версии v.0.1.h, мы начинаем использовать семантическое версионирование. Следующая версия будет обозначена как v.0.1.0

```
[+] Added <изменение – имя фала, для каждого из файлов> <версия в формате v.0.0.0, где цифры изменяются от 0> – Что-то добавлено
[-] Removed <изменение – имя фала, для каждого из файлов> <версия в формате v.0.0.0, где цифры изменяются от 0> – Что-то удалено
[*] Updated <изменение – имя фала, для каждого из файлов> <версия в формате v.0.0.0, где цифры изменяются от 0> – Что-то изменено
[?] <Что-то> <изменение – имя фала, для каждого из файлов> <версия в формате v.0.0.0, где цифры изменяются от 0> – Другие изменения, которые трудно описать предыдущими вариантами
```

Баги и предложения

Предложения и баги направляйте прямиком в Issues.

Важное из ВК

Дизайн

Jira

GitHub + правила

Сайт

API. Руководство для пользователя

Установка

  1. Установите PostgreSQL и создайте сервер.

  2. Создайте базу данных.

  3. Добавьте секретные ключи в окружение. Вы можете получить ключи у тимлида проекта.

  4. Для пользователей Windows: запустите последовательно файлы .scripts/install.bat, .scripts/createadmin.bat, выполните шаги номер 7, 9, 10, запустите файл .scripts/start.bat. Установка будет завершена.

  5. Для пользователей Unix: файлы установки в процессе создания и будут добавлены ближе к следующему релизу.

  6. Полльзователи Unnix могут выполнить следующие действия для установки. Откройте терминал и, находясь в корне проекта, запустите последовательно приведенные команды:

    # /

pipenv shell
pipenv install
python manage.py makemigrations
python manage.py migrate
python manage.py collectstatic
python manage.py createsuperuser

  7. Введите любые данные, они потом будут использоваться для доступа к панели создания пользователей и групп пользователей.

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

    # /

python manage.py runserver

  9. Перейдите на страницу /api/v0/admin. Авторизируйтесь.

  10. Перейдите на страницу /api/v0/auth/o/applications. Создайте там новое приложение oauth2 со следующими данными:

    Name: swagger,
Client ID: <Вставьте сюда SP_OAUTH2_CLIENT_ID>,
Client Secret: Вставьте сюда SP_OAUTH2_CLIENT_SECRET>,
Client Type: Confidential,
Authorization Type: resource-owner passeord based

🚧 Маршруты API 🚧

Для получения доступа к списку маршрутов и моделям в текстовом виде, пройдите по ссылке /api/v0/swagger/, или /api/v0/redoc/.

В дальнейшем, маршруты появятся в данном разделе.

MPU 2019 - 2020