Basic Workflow

This is the current basic workflow when developing components in the component library. Note that it is also possible to develop components in VuFind only.

Set up branches

First check out an issue-specific branch in your local component library clone.

If you are also working on a related VuFind issue, as usually is the case, you need to check out an issue-specific branch in your local VuFind clone.

Run the watch npm script

Before starting work on component files you can run the watch npm script, which will open Pattern Lab in your browser:

npm run watch

While the watch script is running, all changes to component files will be automatically processed and updated in your browser by the script and Browsersync.

Add new component files to VuFind's components.less and components.config.php as required.

Commit changes to component library branch

When you have finished working on component files, add and commit your changes to the issue-specific branch in your local component library clone.

Copy relevant changes to VuFind branch

Copy required component files to VuFind.

Add and and commit all relevant files to your local VuFind branch.