Component Library/Tailwind Starter

A starter template to create your own React component library using TailwindCSS


Report Bug · Request Feature

Table of Contents

1. Motive
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage

Motive

I wasn't able to find a suitable repository that satisfied the following:

• Minimum configuration (for flexibility)
• Latest versions of Tailwind, Webpack Plugins
• Storybook integration
• Typescript support

Built With

• React
• Webpack
• Storybook
• Typescript

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/kokiebisu/component-library-tailwind-starter.git

2. Install NPM packages

   yarn

Usage

1. Import the library into your project

   yarn add component-library-tailwind-starter

2. Try importing the Button component

   import { Button } from 'component-library-tailwind-starter';