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. Install Yalc

Yalc (https://github.com/wclr/yalc) allows you to easilly modify a npm package locally, and use it from another dependent project before publishing the changes officially.

In our case we want Yalc to locally publish changed @victronenergy/mfd-modules and use it from HTML 5 app.

• Install globally on your machine: npm i yalc -g

2. Modify and publish @victronenergy/mfd-modules changes

• In the mfd-modules, Before developing: yalc publish
• In the mfd-modules, after every change: npm run build than yalc push

3. Use from HTML 5 app

• In the venus-html5-app, Override dependency with local build: yalc add @victronenergy/mfd-modules
• In the venus-html5-app, Remove local built dependency to revert back to official release: yalc remove @victronenergy/mfd-modules