XGov Digital Form Builder

contributions

Issues and pull requests are welcome. Please check CONTRIBUTING.md first!

This repository is a mono repo for

• @xgovformbuilder/runner - Hapi server which can 'run' a form from a JSON file
• @xgovformbuilder/designer - A React app to aide in form building
• @xgovformbuilder/model - Serves the data model and other helpers
• @xgovformbuilder/e2e - end to end tests

The repos are forked from DEFRA's digital form builder.

This is a (getting close to) zero-install yarn 2 workspaces repository. .yarnrc.yml allows us to align our yarn environments. Please commit any plugins in .yarn, but do not commit your .yarn/cache. CI will save and restore the caches.

Workspaces will deal with sym-linking the packages, so we do not have to manually run yarn link. It will also deal with hoisting the node_modules for any packages that are shared between the repos, thus decreasing any install times. Hopefully it all just works™️.

Also see the individual repo README files for additional info:

• runner README
• designer README
• model README
• e2e (smoke tests) README

Setup

Always run scripts from the root directory.

1. Make sure you are using node 20 node --version.
2. Make sure you have yarn 1.22+ installed. You do not need to install yarn 2.4+, yarn will detect the yarn 2 binary within .yarn and that will be used.
3. If using the designer:
   • Note that the designer requires the runner to be running with the default NODE_ENV=development settings (see runner/config/development.json) to enable posting and previewing of forms during design.
4. Run $ yarn command to install all dependencies in all workspaces.
5. Run $ yarn build to build all workspaces (this is needed because dependencies can depend on each other).

As already mentioned, always run scripts from the root directory. because workspaces don't have scripts or packages you need to run from inside their folders and by running in the root directory yarn 2 can resolve the scripts/packages properly.

To learn more about workspaces, check these links:

• Workspaces in Yarn
• Workspaces

I want to...

run a specific workspaces' script

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

eg.: yarn designer start or yarn runner add babel-core --dev

run a script for each of the workspaces

$ yarn workspaces foreach run name-of-script

watch and build for changes across all repos

I wouldn't recommend it unless you have a beefy processor.

$ yarn watch

add a dependency to all workspaces

$ yarn add packagename

create a new workspace

1. create a new directory for the workspace and yarn init it
   1. $ mkdir myNewLib
   2. $ cd myNewlib
   3. $ yarn init
2. in the root package.json
   1. add myNewLib to the workspaces object.

Troubleshooting

If you have any problems, submit an issue or send a message via gitter.

Error: ENOENT: no such file or directory, scandir 'xxx/node_modules/node-sass/vendor'

/vendor is not present since it hasn't been built or rebuilt. You may also get this issue with core-js, fsevents, nodemailer etc. $ yarn rebuild to rebuild all the packages $ yarn rebuild only node-sass to rebuild just node-sass

CI

We're using GitHub actions to run our CI process. View a visualisation of the workflow here.

Versioning

Version numbers will automatically increment based on commit messages and SemVer (Major.Minor.Patch). When merging, prepend your merge commit with the following:

• major: or breaking: - for example, breaking: removing feature X. This will increment the MAJOR version - for example: 1.1.0 to 2.0.0
• minor: or feature: - for example, feature: new component. This will increment the MINOR version - for example: 1.1.0 to 1.2.0
• patch: or fix: - for example, fix: url bug - this will increment the PATCH version - for example: 1.0.0 to 1.0.1 (this will also happen by default)

Development environment

The development workflow is triggered whenever a PR is merged into main, and you can monitor it on the repository's action tab.

The workflow contains two separate jobs that run in parallel, one for the Runner and another for the Designer application.

Both jobs work as follows:

1. Build the docker image with all dependencies.
2. Push image to Heroku Container Registry.
3. Release the latest image.

The latest releases will be running here: Runner / Designer.

Smoke tests

A suite of smoke tests are run against all PRs. There is a Cron Job that executes smoke tests against the Heroku deployments and is scheduled to run at midnight every day.

A legacy suite of smoke tests can be found in this repository. They have been removed so that the project can run on node 18.

Smoke tests will be migrated to use cypress.io in the coming months.