DOCUMENTATION & GUIDES

Документация платформы SAQA.

Инструкции по развертыванию в закрытом контуре, настройке окружения, подключению мониторинга и работе с модулями платформы.

Быстрый старт

Quickstart

Пошаговое руководство по быстрому развертыванию рабочего контура SAQA.

Обзор платформы SAQA

SAQA (System Architecture & Quality Assurance) — это комплексная платформа управления инженерным контекстом предприятия. Она объединяет в едином пространстве: • Интерактивную карту архитектуры (Architecture Canvas) • Моделирование процессов и данных (UML, BPMN, ERD) • Инженерную базу знаний с полнотекстовым поиском • Тестирование контрактов (API Client) • Наблюдаемость и телеметрию (Monitoring) • Управление задачами (Kanban) • Анализ рисков и непрерывности (Risk Management) Все модули синхронизированы через единый граф сущностей. Изменение статуса сервиса или его контракта мгновенно отражается во всех связанных разделах.
ℹ️ Примечание: SAQA разворачивается в изолированном контуре компании и не передает внутренний исходный код и архитектурные схемы наружу.

Запуск через Docker Compose

Для запуска демонстрационного или локального контура SAQA достаточно иметь установленный Docker 24+ и Docker Compose v2. 1. Клонируйте репозиторий проекта. 2. Создайте файл конфигурации .env на основе примера. 3. Запустите сервисы одной командой:
bashПример конфигурации
# Клонирование и переход в директорию
git clone https://github.com/DEATHIXX/SAQA.git
cd SAQA

# Подготовка конфигурации
cp .env.example .env

# Запуск основного стека (MongoDB, Redis, Meilisearch, Main-Service, Frontend)
docker compose up -d

# Проверка статуса контейнеров
docker compose ps
💡 Совет: После запуска фронтенд доступен по адресу http://localhost:3000 (или 5173 в dev-режиме), а API — по http://localhost:8080.

Первоначальная инициализация

При первом старте система автоматически проверяет наличие корневого администратора. 1. Откройте интерфейс в браузере: http://localhost:3000/register 2. Зарегистрируйте первую учетную запись — она автоматически получит права Super Admin. 3. Перейдите в раздел «Настройки компании» и укажите полученные в личном кабинете сайта saqa.pro параметры: • company_id • organization_key 4. Сервис Checker автоматически подтвердит лицензию и активирует модули тарифа.

Архитектура и сервисы

Core

Внутреннее устройство платформы, топология сервисов и хранилищ данных.

Топология микросервисов

Платформа SAQA состоит из четырех ключевых архитектурных блоков: 1. **Main Service (Go/Gin):** Основной бэкенд платформы. Обрабатывает запросы пользователей, управляет сущностями систем, сервисов, связей, API-коллекций, канбан-досок и документов. Работает с MongoDB и Redis. 2. **Checker Daemon (Go):** Фоновый сторожевой процесс внутри инсталляции. Регулярно валидирует цифровую подпись лицензии, синхронизируется с центральным Licenser по защищенному mTLS каналу и управляет локальным кэшем прав. 3. **Frontend Application (React/TypeScript + Next.js):** Клиентское SPA-приложение с реактивным UI, векторным рендерингом схем на HTML5 Canvas, поддержкой Markdown/Mermaid и темной/светлой темой. 4. **Meilisearch Engine:** Высокопроизводительный движок полнотекстового индексирования документов и сущностей базы знаний.

Остались вопросы по интеграции?

Наша команда инженеров готова помочь с развертыванием в вашем закрытом контуре, настройкой SSO и миграцией существующих схем.