Skip to content

Latest commit

 

History

History
71 lines (63 loc) · 3.03 KB

README.md

File metadata and controls

71 lines (63 loc) · 3.03 KB
Raw

Описание проекта

API-сервис для мобильного приложения, которое позволяет организовывать работу заказчиков и исполнителей. Предполагается, что исполнитель - работник заказчика по заказу заказчика будет посещать определенную торговую точку; после каждого посещения работником торговой точки заказчик сможет отметить данные об этом посещении. Авторизация происходит по номеру телефона Заказчика / Работника. Создана Админка с функциями создания, удаления и редактирования записей, а также с функцией поиска по имени и номеру работника и названию торговой точки. Создан скрипт для создания 200-500 юзеров разных ролей, 200-500 заказов и 100-150 посещений. Написаны тесты. Настроены CI/CD.

Архитектура БД

Техно-стек

  • python 3.10
  • fastapi 0.78.0
  • asyncpg 0.27.0
  • sqlalchemy 1.4.36
  • alembic 1.7.7
  • uvicorn 0.17.6
  • fastapi-pagination 0.9.1
  • sqladmin 0.14.1
  • postgres 15.1
  • docker 4.19.0
  • poetry 1.5.1

Запуск проекта

  1. Клонировать репозиторий и перейти в него в командной строке
git clone git@github.com:avnosov3/Shops.git
cd Shops/
  1. Создать .env и заполнить
DB_ENGINE=postgresql+asyncpg
POSTGRES_DB=shops
POSTGRES_USER=<Указать имя пользователя>
POSTGRES_PASSWORD=<Указать пароль пользователя>
DB_HOST=db
DB_PORT=5432
  1. Запустить docker compose
docker compose up -d
  1. Заполнить БД
отправить GET запрос на http://127.0.0.1/api/v1/autogenerate/

После запуска появится доступ к:

Запуск тестов

  1. Клонировать репозиторий и перейти в него в командной строке
git clone git@github.com:avnosov3/Shops.git
cd Shops/
  1. Создать .env и заполнить
DB_ENGINE=postgresql+asyncpg
POSTGRES_DB=shops
POSTGRES_USER=<Указать имя пользователя>
POSTGRES_PASSWORD=<Указать пароль пользователя>
DB_HOST=test-db
DB_PORT=5432
DB_TEST_URL=${DB_ENGINE}://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${DB_HOST}:${DB_PORT}/${POSTGRES_DB}
  1. Запустить docker compose
docker compose -f tests-docker-compose.yml up --attach tests