proformajs-vue3

A vue3 version of proformajs-vue.

This repo uses npm workspaces to create two npm libraries:

• proformajs-vue3 - components for creating protocols and running enactments
• proformajs-vue3-perform - a subset of the components needed to run enactments

This repo uses CI to:

• check the code format with prettier
• check the code with a linter
• check for dependency vulnerabilities
• run behavioural tests automatically

Development

npm run dev will run the development demo. You'll need to run npx vite build --watch in the relevant package to see your changes reflected in the demo as you make them.

Testing

Cypress e2e tests can be run in development with npm run test:e2e:dev (tested with chrome).

Committing changes

Before creating a merge request or pushing your changes to main please ensure that your code is linted and formatted and that the tests all run green.
Also ensure that a fresh install has no security vulnerabilities.

Releases

node versionHelper.cjs will check that all packages have the same version number and node versionHelper.cjs version will set the same version number for all packages.

npm run publish will run through the steps required to publish the two packages (and stop if it finds an issue with a couple of checks along the way). Note that its important to publish after a build and not after the test because the test uses a different kind of build.

Skeleton

The skeleton for this project was created with npm init vue@latest (3.4.27) which generated the rest of this README.

Workspaces were then created with npm init -w .packages/map etc.

Licensing

This project is owned by Openclinical CIC and dual-licensed with GPLv3 and a commercial license (please email [email protected] for more details). Contributions to the project are very welcome, and will be recognised via the contrib file, but will need to have copyright assigned to the CIC.