machuwey/react-lib-component-template

A template to quickstart the development of react component libraries using storybook

React Library Component Template

This project serves as a template for creating React component libraries. It includes a pre-configured environment with Storybook to help visualize components during development.

It includes native storybook examples and some custom /components I made based from a tutorial

Cloning the Repository

To clone the repository, run the following command:

git clone https://github.com/your-username/react-lib-component-template.git
cd react-lib-component-template

Replace your-username with the actual username where the repository is hosted.

Initializing the Project

After cloning the project, you need to install the dependencies. Run the following command:

npm install

Building the Project

To build the component library, execute:

npm run build-lib

This will compile the source files into the dist directory which can then be used in other projects.

Running Storybook

To visualize your components with Storybook, run:

npm run storybook

This will start the Storybook server and open it in your default web browser.