3D конфигуратор поездов

Монорепо состоит из двух частей:

• configurator-main - библиотека @univer/configurator
• example-main - пример приложения, которое использует библиотеку

Требования

• Node.js LTS (рекомендуется 20+)
• npm 10+

Проверка версий:

node -v
npm -v

Установка и подготовка

Запускать из корня репозитория:

npm run install:all
npm run build:configurator

Запуск в режиме разработки

npm run dev

Если в configurator-main не было изменений и вообще нужно только поднять пример приложения:

npm run dev:nobuild

Production-сборка

npm run build
npm run preview

Или одной командой:

npm run build:preview

Альтернатива: раздать папку dist через любой статический сервер (например, python -m http.server 3000 -d dist или npx --yes serve -s dist).

Тестирование

Проект использует Jest для модульного тестирования.

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

cd configurator-main

# Запустить все тесты
npm test

# Запустить тесты в режиме наблюдения
npm run test:watch

# Сгенерировать отчет о покрытии
npm run test:coverage

Покрытие тестами

Отчеты о покрытии генерируются в директории configurator-main/coverage/. Откройте coverage/lcov-report/index.html в браузере для просмотра HTML-отчета.

CI/CD Pipeline

Проект использует GitHub Actions для непрерывной интеграции. Pipeline запускается автоматически при:

• Каждом push в ветки main, master или develop
• Любом pull request (независимо от целевой ветки)

Что делает CI Pipeline

1. Тестирование: Запускает все модульные тесты с генерацией покрытия
2. Проверка типов: Валидирует TypeScript типы в библиотеке
3. Сборка: Собирает библиотеку и пример приложения
4. Артефакты: Сохраняет результаты сборки на 7 дней

Статус CI

Проверьте вкладку Actions для просмотра статуса последних запусков CI.

Troubleshooting

1) module not found / пакет не находится

Причина: зависимости не установлены в одной из папок.

Решение:

npm run install:all
npm run build:configurator

2) Ошибка импорта @univer/configurator

Причина: библиотека не собрана.

Решение:

npm run build:configurator

3) Конфликты зависимостей после обновлений

Причина: поврежденный кэш/lock-файл/node_modules.

Решение:

npx --yes rimraf "configurator-main/node_modules" "configurator-main/package-lock.json" "example-main/node_modules" "example-main/package-lock.json"
npm run install:all

4) EADDRINUSE (порт занят)

Причина: порт dev/preview уже используется.

Решение:

npm --prefix ./example-main run dev -- --port 5174