VSTA Orders Hub¶

Добро пожаловать в документацию системы управления гарантийными заявками VSTA Orders Hub.

🏗️ О проекте¶

VSTA Orders Hub — это современная система для автоматизации процесса обработки гарантийных заявок между управляющими компаниями и застройщиками. Система обеспечивает прозрачный и эффективный обмен информацией о гарантийных случаях.

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

📝 Создание и управление заявками — простое создание заявок с детальным описанием проблемы
🔄 Отслеживание статусов — полный жизненный цикл заявки от создания до закрытия
📎 Работа с вложениями — возможность прикреплять фото и документы
🔍 Фильтрация и поиск — удобный поиск заявок по различным критериям
📊 Отчетность — детальная информация о статусе выполнения работ

🚀 Доступ к API¶

🔗 API документация (Swagger): http://localhost:8000/api/v1/docs
🩺 Health check: http://localhost:8000/health

🏛️ Архитектура¶

Технологический стек¶

Backend: FastAPI + Python 3.12
База данных: PostgreSQL 15
ORM: SQLAlchemy 2.0 (асинхронный)
Миграции: Alembic
Контейнеризация: Docker & Docker Compose
Документация: MkDocs Material

Структура проекта¶

vsta_orders_hub/
├── app/                    # Основное приложение
│   ├── api/               # API эндпоинты
│   ├── core/              # Основные настройки
│   ├── models/            # SQLAlchemy модели
│   ├── schemas/           # Pydantic схемы
│   └── services/          # Бизнес-логика
├── docs/                  # Документация
├── alembic/              # Миграции базы данных
├── docker-compose.yml    # Docker конфигурация
└── main.py              # Точка входа

📋 Основные сущности¶

WarrantyClaim (Гарантийная заявка)¶

Центральная сущность системы, содержащая:

Номер заявки — автоматически генерируемый уникальный номер
Описание проблемы — детальное описание гарантийного случая
Адрес — точное местоположение проблемы
Данные заявителя — контактная информация (ФИО, телефон, email)
Статус — текущее состояние заявки
Исполнитель — ответственный за выполнение работ
Вложения — фотографии и документы

Статусы заявок¶

Статус	Описание
Новая	Заявка только что создана
Передано застройщику	Заявка отправлена исполнителю
Принято застройщиком	Исполнитель принял заявку в работу
Выполнено застройщиком	Работы завершены
Отменено	Заявка отменена

WarrantyClaimResult (Результат работ)¶

Содержит информацию о выполненных работах:

Комментарий — описание выполненных работ
Вложения — фотографии результата
Дата выполнения — время завершения работ

🔗 Полезные ссылки¶

📖 Сценарии использования — детальные примеры работы с API

🆘 Поддержка¶

При возникновении вопросов или проблем:

Проверьте документацию в разделе Сценарии использования
Создайте issue в GitHub репозитории
Обратитесь к команде разработки

VSTA Orders Hub — делаем управление гарантийными заявками простым и эффективным! 🚀