MFD Modules

This repository contains shared modules for the Venus OS hosted web app

Making a release

This package uses semantic-release for automated version management and package publishing.

To publish a new release:

1. Set the commit name according to the commit message convention
2. Manually trigger the Publish action in Gitlab after merging your merge request

Development

Required Node Version 18 LTS

Setup

1. Clone this repository
2. Run npm install to install dependencies
3. Run npm run build to build the modules

Use in the HTML5 app

1. Remove the version from npm: npm remove @victronenergy/mfd-modules
2. Run npm link ../victron-mfd-modules
3. Link React: npm link react (Prevents difference in React versions between the two projects)
4. Build the modules after every change
5. Run npm unlink ../victron-mfd-modules when you're done
6. Add back the version to npm: npm add @victronenergy/mfd-modules

Alternative local development with Yalc

1. Install globally on your machine: npm i yalc -g
2. In project, Before developing: yalc add @victronenergy/mfd-modules
3. In module, Before developing: yalc publish
4. In module, after every change: npm run build than yalc push
5. In project, Finished with developing: yalc remove @victronenergy/mfd-modules