digital form builder

Конструктор цифровых форм XGov

взносы

Проблемы и запросы на включение приветствуются. Пожалуйста, сначала проверьте CONTRIBUTING.md!

Этот репозиторий представляет собой монорепозиторий для

• @xgovformbuilder/runner — сервер Hapi, который может «запускать» форму из файла JSON.
• @xgovformbuilder/designer — приложение React, помогающее в построении форм.
• @xgovformbuilder/model — обслуживает модель данных и другие помощники.
• @xgovformbuilder/e2e — сквозные тесты

Репозитории созданы на базе конструктора цифровых форм DEFRA.

Это (приближается к) репозиторий рабочих пространств Yarn 2 с нулевой установкой. .yarnrc.yml позволяет нам выравнивать среду пряжи. Пожалуйста, сохраните любые плагины в .yarn, но не сохраняйте свой .yarn/cache. CI сохранит и восстановит кэши.

Рабочие области будут заниматься символическими связями пакетов, поэтому нам не придется вручную запускать yarn link . Он также будет заниматься поднятием node_modules для любых пакетов, которые являются общими для разных репозиториев, тем самым сокращая время установки. Надеюсь, все это работает™️.

Дополнительную информацию также смотрите в отдельных файлах README репозитория:

• бегун README
• дизайнер README
• модель README
• e2e (дымовые тесты) README

Настраивать

Всегда запускайте сценарии из корневого каталога.

1. Убедитесь, что вы используете узел 20 node --version .
2. Убедитесь, что у вас установлена ​​версия Yarn 1.22+. Вам не нужно устанавливать Yarn 2.4+, Yarn обнаружит двоичный файл Yarn 2 в .yarn и будет использован.
3. Если использовать конструктор:
   • Обратите внимание, что дизайнер требует, чтобы бегун работал с настройками NODE_ENV=development по умолчанию (см. runner/config/development.json), чтобы разрешить публикацию и предварительный просмотр форм во время проектирования.
4. Запустите команду $ yarn , чтобы установить все зависимости во всех рабочих областях.
5. Запустите $ yarn build , чтобы собрать все рабочие области (это необходимо, поскольку зависимости могут зависеть друг от друга).

Как уже говорилось, всегда запускайте скрипты из корневого каталога. поскольку в рабочих пространствах нет сценариев или пакетов, которые вам нужно запускать из их папок, и, запустив в корневом каталоге, Yarn 2 может правильно разрешить сценарии/пакеты.

Чтобы узнать больше о рабочих пространствах, проверьте эти ссылки:

• Рабочие области в Yarn
• Рабочие пространства

Я хочу...

запустить сценарий определенного рабочего пространства

$ yarn [runner|designer|model] name-of-script

например: yarn designer start или yarn runner add babel-core --dev

запустить скрипт для каждого из рабочих пространств

$ yarn workspaces foreach run name-of-script

наблюдайте и создавайте изменения во всех репозиториях

Я бы не рекомендовал его, если у вас нет мощного процессора.

$ yarn watch

добавить зависимость ко всем рабочим пространствам

$ yarn add packagename

создать новое рабочее пространство

1. создайте новый каталог для рабочей области и запустите его в пряже
   1. $ mkdir myNewLib
   2. $ cd myNewlib
   3. $ yarn init
2. в корневом package.json
   1. добавьте myNewLib к объекту workspaces .

Поиск неисправностей

Если у вас возникли проблемы, сообщите о проблеме или отправьте сообщение через gitter.

Ошибка: ENOENT: нет такого файла или каталога, scandir 'xxx/node_modules/node-sass/vendor'

/vendor отсутствует, поскольку он не был построен или перестроен. Вы также можете столкнуться с этой проблемой с core-js , fsevents , nodemailer и т. д. $ yarn rebuild для пересборки всех пакетов $ yarn rebuild only node-sass для пересборки только node-sass

КИ

Мы используем действия GitHub для запуска процесса CI. Посмотреть визуализацию рабочего процесса можно здесь.

Управление версиями

Номера версий будут автоматически увеличиваться в зависимости от сообщений о фиксации и SemVer (Major.Minor.Patch). При слиянии добавьте к коммиту слияния следующее:

• major: или breaking: — например, breaking: removing feature X Это увеличит ОСНОВНУЮ версию, например: с 1.1.0 до 2.0.0.
• minor: или feature: — например, feature: new component . Это увеличит МИНОРНУЮ версию, например: с 1.1.0 до 1.2.0.
• patch: или fix: - например, fix: url bug - это увеличит версию PATCH - например: с 1.0.0 до 1.0.1 (это также произойдет по умолчанию)

Среда разработки

Рабочий процесс разработки запускается каждый раз, когда PR объединяется с основным, и вы можете отслеживать его на вкладке действий репозитория.

Рабочий процесс содержит два отдельных задания, которые выполняются параллельно: одно для приложения Runner, а другое для приложения Designer.

Обе работы работают следующим образом:

1. Создайте образ Docker со всеми зависимостями.
2. Отправьте изображение в реестр контейнеров Heroku.
3. Опубликуйте последнее изображение.

Последние релизы будут запускаться здесь: Runner/Designer.

Дымовые испытания

Для всех PR проводится комплекс дымовых тестов. Существует задание Cron, которое выполняет дымовые тесты для развертываний Heroku и должно запускаться в полночь каждый день.

Устаревший набор дымовых тестов можно найти в этом репозитории. Они были удалены, чтобы проект мог работать на узле 18.

Дымовые тесты будут перенесены на использование cypress.io в ближайшие месяцы.