@taal-enterprise/shared-components

Description

This repo is the taal shared component library released as an npm package.

Getting started

Installation

1. Run yarn

Storybook

You can visualise the shared components by running storybook:

1. Run yarn storybook
2. It should open the sandbox in your favorite browser

Testing the component library in a project before publishing

Its useful to test to see if the library is working correctly without having to publish. The following are instructions on how to do to this:

1. Run npm link in the root of this project
2. Run npm link @taal-enterprise/shared-components in the consuming project. If you now run the consuming project this should now be linked to your local repo.
3. In order for the npm link to work correctly and avoid any errors the peer dependancies of the component library need to be defined as aliases in the webpack configuration. As our current projects are using next.js, the config below needs to be added to next.config.js:

webpack: (config, options) => {
  config.resolve.alias['styled-components']  = path.resolve('./node_modules/styled-components')
  config.resolve.alias.react  = path.resolve('./node_modules/react')
  config.resolve.alias['react-dom']  = path.resolve('./node_modules/react-dom')
  return config
},

As we add more peer dependancies this will need to be updated. More details on why the above is needed can be found here

1. Run yarn build in the component library repo anytime you need to make updates. This will be picked up by the consuming project.

For more on npm link and how it works click here

Publishing the component library

1. Run yarn build to create the bundled library.
2. Run npm login (You should already a npm account and have permison to publish the package)
3. Run npm run release -- --message='DEVP-<number>: <comment>'
4. Follow the the prompts and library will be automatically published.

For more details on using np click here