API: Сервис поиска ближайших машин для перевозки грузов 🚚

Выполнено в рамках тестового задания

Основные возможности

1. Создание нового груза
   • Указание локаций pick-up и delivery, веса и описания груза.
   • Локации определяются по введенному zip-коду.

2. Получение списка грузов
   • Включает локации pick-up и delivery, количество ближайших машин (<= 450 миль).

3. Получение информации о конкретном грузе по ID
   • Включает локации pick-up и delivery, вес, описание.
   • Список всех машин с расстоянием до выбранного груза (в милях).

4. Редактирование машины по ID
   • Изменение локации (определяется по введенному zip-коду).

5. Редактирование груза по ID
   • Изменение веса и описания груза.

6. Удаление груза по ID

7. Фильтр списка грузов
   • Фильтрация по весу и расстоянию до ближайших машин.

8. Автоматическое обновление локаций всех машин
   • Локации всех машин обновляются на другие случайные каждые 3 минуты.

Установка и запуск

1. Склонируйте репозиторий:

git clone https://github.com/storlay/search_nearest_cars.git

2. При необходимости измените содержимое файла .env-example

POSTGRES_DB=your_postgres_db
POSTGRES_USER=your_postgres_user
POSTGRES_PASSWORD=your_postgres_password

3. Запустите проект с помощью Docker Compose*:

docker-compose up --build

*При запуске приложение автоматически загружает и заполняет базу данных списком уникальных локаций из файла app/data/uszips.csv и создаёт 20 машин со случайными локациями.

4. Приложение будет доступно по адресу http://127.0.0.1:8000

Использование

• Документация API доступна по адресам:

  • http://127.0.0.1:8000/docs (Swagger)
  • http://127.0.0.1:8000/redoc (Redoc)

• Мониторинг и управление фоновыми задачами доступны по адресу:

  • http://127.0.0.1:5555 (Flower)