Matching «Prosept» dealer

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

Matching «Prosept» dealer - API redoc

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

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

• Установите и активируйте виртуальное окружение.

• Установите зависимости из файла requirements.txt

  python -m pip install --upgrade pip
  pip install -r requirements.txt
  

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

  DB_NAME=postgres
  POSTGRES_USER=postgres
  DB_HOST=localhost
  DB_PORT=5432
  POSTGRES_PASSWORD=password
  CORS_ORIGINS=http://localhost:3000,http://127.0.0.1:3000
  

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

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

• Загрузите в базу данных подготовленные данные.

  P.S. Выполнение скрипта может занять продолжительное время(~10 минут)

  python load_data.py
  

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

  uvicorn app.main:app --reload
  

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

• Админка, с некоторыми таблицами БД, будет доступна по url-адресу 127.0.0.1:8000/admin

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

• Клонируйте репозиторий.

• Перейдите в папку 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:

  ~$ docker-compose up -d --build
  

• В контейнере backend выполните миграции:

  ~$ docker-compose exec backend alembic revision --autogenerate -m "Initial migration"
  
  ~$ docker-compose exec backend alembic upgrade head
  

• Загрузите в базу данных подготовленные данные.

  P.S. Выполнение скрипта может занять продолжительное время(~10 минут)

  ~$ docker-compose exec backend python load_data.py
  

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

Админка, с некоторыми таблицами БД, будет доступна по url-адресу 127.0.0.1/admin

WEB-PgAdmin будет доступен по url-адресу 127.0.0.1:5050

Авторы:

• Backend:

  • Иван
  • Сергей

• Data Science:

  • Кристина

• Frontend:

  • Дмитрий
  • Глеб