Getting started

Run

yarn

after cloning to get started.

Start the project by running

yarn storybook

Creating a new component

Create a new component by creating a folder with the components name. Remember to export the component in the index.tsx file or it won't be available to use when installing bredvid-ui.

Customizing tailwindcss

If you want to add colors or other properties to tailwind you need to add properties to both tailwind.config.js and plugin.ts files. We're looking for a workaround for this but as of now you'll need to put your changes both places.

Building and upgrading NPM package

When creating a pull request using [major], [minor] or [patch] in the name will trigger an automatic build and upgrade of the Bredvid-UI NPM package. If you want to push to main without building NPM simply omit the major, minor or patch labels.

PS: If your PR only contains one commmit then it is this commit that needs to contain the labelling for the NPM build action to trigger.

Example:

Breaking changes [major]

Or

New feature [minor]

Or

Minor improvement to existing component [patch]

After pushing to main

Update your project by running

npm i @bredvid/bredvid-ui

or

yarn add @bredvid/bredvid-ui

to update the bredvid-ui package