Sestek UI Components

A React component library built with TypeScript, Tailwind CSS, and Shadcn.

Getting Started

Prerequisites

• Node.js (v20 or higher recommended)

Installation

1. Clone the repository:

git clone https://github.com/sestek/ui-component.git
cd ui-component

2. Install dependencies:

npm install
# or
yarn install

Development

Running Storybook

To start the Storybook development environment:

npm run storybook
# or
yarn storybook

This will start Storybook at http://localhost:6006

Available Scripts

• npm run dev - Starts the Vite development server
• npm run build - Builds the library for production
• npm run lint - Runs ESLint to check code quality
• npm run preview - Preview the production build locally
• npm run storybook - Starts Storybook development server
• npm run build-storybook - Builds Storybook for production

Usage

Installation in Your Project

npm install sestek-component
# or
yarn add sestek-component

Using Components

import { Tab } from "sestek-component";
import "sestek-component/css";

function App() {
  return <Tab />;
}

Features

• 🎨 Built with Tailwind CSS
• 🚀 Powered by Vite
• 📚 Documented with Storybook
• 🎯 Written in TypeScript
• ⚡ Optimized for production

License

This project is licensed under the MIT License - see the LICENSE file for details

This README provides:
- An introduction to the project
- Installation instructions
- Development setup steps
- Available scripts and their purposes
- Usage examples
- Key features
- Contributing guidelines
- License information

You can customize this further by:
- Adding specific component documentation
- Including screenshots or GIFs of components
- Adding badges (build status, version, etc.)
- Including troubleshooting sections
- Adding more detailed usage examples
- Including links to additional documentation