1. Общие сведения

Программное обеспечение EKSLi АгроСорт «Качество» предназначено для автоматизированного анализа качества плодоовощной продукции и управления конфигурациями оборудования оптического сортировщика.
Правообладатель программного обеспечения: ООО «Прогресс».
Настоящий документ содержит требования к программному окружению и последовательность действий, необходимых для установки, запуска и проверки работоспособности программного обеспечения.

2. Требования к программно-аппаратной платформе

Для штатной эксплуатации программного обеспечения используется следующая конфигурация:
Для установки и запуска программного обеспечения необходимы: Docker, Docker Compose, Make.
Для локальной разработки без использования Docker дополнительно необходимы Node.js версии 24 или выше и npm версии 11 или выше.

3. Получение программного обеспечения

Экземпляр программного обеспечения для экспертной проверки предоставляется правообладателем по реквизитам доступа, указанным в заявлении в Реестр. Публичная версия настоящего документа не содержит реквизиты доступа к исходному коду.
После получения экземпляра программного обеспечения его необходимо распаковать в каталог на вычислительном оборудовании, предназначенном для установки. Все дальнейшие команды выполняются из корневого каталога проекта.
Все дальнейшие команды выполняются из корневого каталога проекта.

4. Первоначальная подготовка

Перед первой сборкой необходимо выполнить первоначальную настройку программного окружения:
make prebuild
Команда автоматически формирует необходимые файлы конфигурации и переменные окружения, включая .env.
Повторное выполнение первоначальной настройки при штатном запуске установленной версии программного обеспечения не требуется.

5. Сборка программного обеспечения

Для сборки production-версии необходимо выполнить:
make build
В результате формируются Docker-образы программных компонентов, необходимые для запуска программного обеспечения.

6. Запуск программного обеспечения

После завершения сборки необходимо выполнить:
make up
Команда запускает production-конфигурацию программного обеспечения и необходимые сервисы.

7. Первоначальная инициализация базы данных

При первом запуске необходимо выполнить инициализацию базы данных:
make seed
Команда создает первоначальные данные, необходимые для работы системы.
Инициализация выполняется при первом развертывании программного обеспечения.

8. Проверка успешности установки

Для проверки состояния запущенных компонентов необходимо выполнить:
make status
После успешной установки и запуска доступны следующие программные интерфейсы:
Установка считается успешно выполненной, если программные компоненты запущены, команда make status подтверждает их работоспособность и пользовательский интерфейс доступен по указанному адресу.
Эти адреса также прямо приведены в README.

9. Проверка без подключения промышленного оборудования

Для разработки и тестирования предусмотрен программный имитатор REST API реального оптического сепаратора.
Для запуска инфраструктуры разработки используется команда:
make dev
В данном режиме запускаются MongoDB, Mongo Express, Prometheus, OpenTelemetry Collector, Node Exporter и программный имитатор сепаратора.
Программный имитатор позволяет проверить взаимодействие программных компонентов без подключения реального сортировочного оборудования.
Для запуска только MongoDB и Mongo Express может использоваться команда:
make dev-db

10. Остановка программного обеспечения

Для штатной остановки production-конфигурации используется команда:
make down
Для последующего запуска используется:
make up

11. Обновление программного обеспечения

При необходимости полной пересборки программного обеспечения без использования ранее созданного кеша выполняется:
make rebuild-all
После завершения пересборки состояние компонентов проверяется командой:
make status
Перечень этих команд соответствует Makefile-командам, описанным в документации проекта.

12. Особенности установки и эксплуатации

Программное обеспечение представляет собой контейнеризированную систему. Frontend и Backend собираются в отдельных Docker-образах. Для production-сборки используются runtime-образы программных компонентов.
Для полноценной эксплуатации в составе оптического сортировщика требуется подключение соответствующего промышленного оборудования. Для проверки установки и базовой работоспособности программных компонентов допускается использование предусмотренных программных имитаторов.