@energybox/react-ui-library
v14.9.7
Published
Energybox React UI Library
Downloads
949
Maintainers
Keywords
Readme
Intro
This project is using npmjs.com as a npm package repository and is publicly available. Please go to Company's LastPass > Shared Dev > npmjs.com to find shared credentials to the account.
Initial Setup
After running the initial yarn install
(we use yarn, not npm), run yarn husky:setup
. We use husky
/lint-staged
/prettier
to format our staged code consistently every time we create a new commit.
NOTE: Please don't run yarn husky:setup
more than once, or else you will add multiple yarn lint-staged
commands inside your .husky/pre-commit
file
Release
- Increase library version
- Commit
- Go to pipelines and select pipeline that includes version to be released.
- Tap "Publish"
Local Development
To use a local version of the react-ui-library in another FE repo during development:
from react-ui-library,
- run
yarn yalc:serve
ORyarn yalc:publish
- run
in the target local FE repo,
- run
yalc add @energybox/react-ui-library
(Initial connect) - run
yarn install
- run
yalc update @energybox/react-ui-library
(re-connecting) - run ``yalc remove @energybox/react-ui-library` (Disconnect)
- run
When upgrading to a new version of @energybox/react-ui-library, ensure the following steps are completed:
- After upgrading the library version, make sure to update the following repositories with the newest version:
- Connect
- ONE
- Simplycheck
- Perform rigorous testing in all the above repositories to ensure the new version does not introduce any issues or regressions.
- Update the package.json files in all relevant repositories to use the same latest version of @energybox/react-ui-library.
- After upgrading the library version, make sure to update the following repositories with the newest version: