Lavender-Component-Library

React components for use in Lavender Dashboard and Extension

Install Instructions

npm i;
npm run storybook;

Publish a Version of this Library for internal use

1. Update the package.json with a new version number. Please follow common numbering practices, follows the format MAJOR.MINOR.PATCH, where:

-  MAJOR version should be incremented for incompatible changes.
-  MINOR version should be incremented for backwards-compatible functionality additions.
-  PATCH version should be incremented for backwards-compatible bug fixes.

2. In the terminal run the command

npm publish

This will publish the repo to the teams npm Organization under @lavender-ai

Errors in publishing

If you can not publish make sure you have the following.

1. Do you have a NPM_TOKEN? This is created with your https://www.npmjs.com/settings/<your_account_name>/tokensaccount

2. In your shell profile do you have your NPM_TOKEN set? In your .zshrc or .bashrc shell profile make sure you have the flowing

export NPM_TOKEN="<Your token>"

if you change this make sure you run source to for your terminal picks up the value.

source ~/.zshrc

or just close and open a new terminal window.

The top level .npmrc file in this repo will pickup that token to publish.

3. Are you login to npm in the terminal?

To check if you are login to npm in your terminal run

npm whoami

If this errors out then you need to login via

npm login

4. Are you invited to the npm Organization? Check with the Casey to see if you are invited

Adding a Custom Icon

Instructions listed in src/particles/Icon/README.md