som-energia/somenergia-ui

Common components for Som Energia UI projects

somenergia-ui

Common React/MUI components for Som Energia UI projects

Documentation

Install

npm install --save @somenergia/somenergia-ui

Adding dependencies

• Do not add them in package.json's dependencies key
• Add them both in peerDependencies and developmentDependencies
• Ensure they are filtered by the externals in vite-config.js' build.rollupOptions.externals
• If the build creates a vendor-***.js as output, means that you failed to filter it
• To know wich module is generating the vendor-***.js, you can get the name of the library by uncomenting the code in vite-config.js (build.rollupOptions.output.manualChunks)

Using unreleased components in another project

First build the library locally

npm run build

From the other project run:

npm install ../somenergia-ui

Release process

• Update version package.json and CHANGES.md
• Tag the release somenergia-ui-M.m.p
• On pushing the version tag, automated CI will publish the package in npm
• Right now the storybook of the CI is failing so the following command must be run by hand

npm run deploy-storybook