@bloomreach/babujs v3.12.0

Babu.js

This is a component shared library build in React. All the components are generic and can be used in any React application. The main goal of this library is to standardize the look and feel across multiple apps and to enable fast development.

Local Development

• Install Yalc
• Go to your Babu.js directory and run yalc publish
  • This will create a package with the Babu.js changes and add it to do Yalc store
  • A message like @bloomreach/babujs@<version> published in store should have shown in the terminal
• Go to the app where the Babu.js changes will be used/tested
  • Let's assume the app is Maple
  • Go to the directory of the app and run yalc add @bloomreach/babujs@<version>
  • Start dev runner on parent package npm run devserver
• Everytime you make changes in Babu.js, you need to update the package in the store
  • In the Babu.js directory run again yalc publish
  • In the Maple directory run yalc update @bloomreach/babujs@<version>

Publishing

• Update the library to the new version
  • Version update:
    • Bug/Security fixes npm version patch
    • New/Update components npm version minor
    • Breaking changes npm version major
• Create a merge request (based on main branch)
• Ask for code review. At least 1 approval is required
  • Once approved, click the button to merge your branch into the main branch
• Publish the new package npm publish (this won't be needed it anymore when automatic publishing is added to the repo)

Demo page (it will be replaced with Storybook)

• Update the demo page with npm run updatePortal
  • This will build the library, push to s3 tools-static and refresh the changes
  • The showcase site will be available immediately at https://tools-static.bloomreach.com/sharedUIComponents//
• Check out the demos locally with npm start
  • Access the page from http://0.0.0.0:3003/webpack-dev-server/
• Add a component to the demo page
  • components/ Add your component brName.js
  • components/index.js Add your component export
  • demoPages/ Add a react class brNamePage.js using DemoPage as your component extend class instead of React.Component
  • demoPagse/index.js Add your component export
  • app.js Add link on demo page
  • router.js Add routing