@victronenergy/mfd-modules
v3.4.1
Published
This repository contains shared modules for the [Venus OS hosted web app](https://github.com/victronenergy/venus-html5-app)
Downloads
38
Readme
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:
- Set the commit name according to the commit message convention
- Manually trigger the
Publish
action in Gitlab after merging your merge request
Development
Required Node Version 18 LTS
Setup
- Clone this repository
- Run
npm install
to install dependencies - Run
npm run build
to build the modules
Use in the HTML5 app
- Remove the version from npm:
npm remove @victronenergy/mfd-modules
- Run
npm link ../victron-mfd-modules
- Link React:
npm link react
(Prevents difference in React versions between the two projects) - Build the modules after every change
- Run
npm unlink ../victron-mfd-modules
when you're done - Add back the version to npm:
npm add @victronenergy/mfd-modules
Alternative local development with Yalc
- Install globally on your machine:
npm i yalc -g
- In project, Before developing:
yalc add @victronenergy/mfd-modules
- In module, Before developing:
yalc publish
- In module, after every change:
npm run build
thanyalc push
- In project, Finished with developing:
yalc remove @victronenergy/mfd-modules