Getting Started

Local development

Option 1

1. Run npm build or npm run dev from cludo-search-components project
2. Run npm link
3. Open vs code folder to solution in which you want to use your local component development
4. Run npm link @cludosearch/cludo-search-components

You should now be using your locally developed shared library in the project that has it as a dependency

Option 2

You can reference this library locally by adding the local package to an NPM configuration.

npm install --save ./../cludo-search-components

Publishing a new version

In order to publish a new package, the version number must be updated. Make sure to update this by running npm version [ major | minor | patch ] on your PR branch. Documentation for this command can be found here.

Running Storybook locally

Versions 0.18.3+ of the component library include Storybook documentation of components. To build and run Storybook locally, make sure you have updated packages with npm install and then run npm run storybook.