StarkUI – React + TypeScript UI Component Library

StarkUI is a TypeScript-first React component library powered by Tailwind CSS utilities and built with Vite. It currently focuses on delivering a polished button primitive with plans to expand the catalogue over time.

🚀 Features

• React 18+ compatible components written in modern TypeScript.
• Tailwind-driven design tokens via tailwind-variants for consistent styling.
• Vite-powered build pipeline outputting ESM and CommonJS bundles with source maps.
• Storybook workspace for interactive documentation and visual QA.

📦 Installation

Install the published package together with its peer dependency:

npm install @gurpal-singh-rc/starkui
# or
yarn add @gurpal-singh-rc/starkui
# or
pnpm add @gurpal-singh-rc/starkui

Configure Tailwind

In your tailwind.config.js (or .mjs):

import starkuiContent from "@gurpal-singh-rc/starkui/tailwind.content.js";

export default {
  content: [...starkuiContent],
};

🛠️ Local Development

1. Clone the repository

   git clone <repository-url>
   cd StarkUI/starkUi

2. Install dependencies

   npm install

3. Start the playground app

   npm run dev

4. Open Storybook

   npm run storybook

Both commands support hot module replacement for rapid iteration.

📜 Available Scripts

| Script | Description | | ------------------- | ---------------------------------------------------------- | | npm run dev | Launches the Vite development playground. | | npm run storybook | Starts Storybook at http://localhost:6006. | | npm run build | Generates the library bundles and TypeScript declarations. |