neeearina / jobikAPI

API для мобильного приложения "Джобик". Хакатон

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Подробнее о «Джобике» вы можете узнать здесь:

Презентация

Что реализовано в API:

  • Регистрация пользователей по токенам
  • Информация по категориям и профессиям

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

После запуска проекта документация будет доступна по пути /swagger/

Основные настройки проекта

Склонируйте репозиторий с помощью git команды:

git clone https://github.com/neeearina/jobik_api.git

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

python3 -m venv venv 
source venv/bin/activate 

Зависимости проекта

Установить зависимости для прод режима:

pip3 install -r requirements/prod.txt

для дев режима (включает в себя установку продовых зависимостей):

pip3 install -r requirements/dev.txt

для тестов:

pip3 install -r requirements/test.txt

Переменные виртуального окружения

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

Значение переменной DJANGO_DEBUG в прод режиме False, в дев режиме True. От этого значения зависит отображение данных на страницах.

Секретный ключ

Получить данные секретного ключа для проекта можно с помощью выполнения следующих команд в терминале:

python3 manage.py shell
from django.core.management.utils import get_random_secret_key
get_random_secret_key()

Последующие команды выполняются из директории проекта jobik_api

Выполните миграции для создания таблиц в БД:

python3 manage.py migrate

Актуальная ER диаграмма со структурой БД по ссылке

ERD

Загрузите фикстуры в БД:

python3 manage.py loaddata fixtures/categories.json
python3 manage.py loaddata fixtures/professions.json

Создайте пользователя для входа в admin-панель:

После выполнения команды заполните все нужные поля в консоли (юзернейм, почта, пароль и т.д.)

python3 manage.py createsuperuser

Запустите проект с помощью следующей команды и перейдите по ссылке в терминале:

python3 manage.py runserver

About

API для мобильного приложения "Джобик". Хакатон

License:MIT License


Languages

Language:Python 100.0%