Skip to content

bl-hori/harukit-ui

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

23 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Harukit UI

A modern, accessible, and customizable React component library built with TypeScript and Tailwind CSS. This monorepo contains the component library, documentation site, CLI tool, and development utilities.

πŸš€ Features

  • Modern React Components: Built with React 19 and TypeScript
  • Tailwind CSS Integration: Fully customizable with Tailwind CSS
  • Accessibility First: All components follow WCAG guidelines
  • TypeScript Support: Full type safety and IntelliSense
  • CLI Tool: Generate components and manage your UI library
  • Comprehensive Documentation: Interactive docs with examples
  • Monorepo Architecture: Efficient development with Turborepo

πŸ“¦ What's Inside

This Turborepo includes the following packages and applications:

Apps

  • docs: Documentation site built with Fumadocs and MDX

πŸ› οΈ Tech Stack

  • Framework: Next.js 15 with React 19
  • Styling: Tailwind CSS 4
  • Language: TypeScript 5.8
  • Build Tool: Turborepo
  • Package Manager: pnpm
  • Documentation: Fumadocs with MDX
  • Linting: ESLint with Prettier

πŸš€ Quick Start

Prerequisites

  • Node.js 18 or higher
  • pnpm (recommended) or npm/yarn

Installation

  1. Clone the repository

    git clone <repository-url>
    cd harukit-ui
  2. Install dependencies

    pnpm install
  3. Start development

    # Start all applications
    pnpm dev
    
    # Or start specific apps
    pnpm docs:dev    # Documentation site
    pnpm web:dev     # Main web app

πŸ“š Available Scripts

Root Level Commands

# Development
pnpm dev                    # Start all apps in development mode
pnpm build                  # Build all packages and apps
pnpm lint                   # Lint all packages and apps
pnpm format                 # Format code with Prettier
pnpm check-types            # Type check all packages

# Specific App Commands
pnpm docs:dev              # Start documentation site
pnpm docs:build            # Build documentation site
pnpm cli:build             # Build CLI tool

Individual Package Commands

# Build specific packages
pnpm --filter=docs build
pnpm --filter=@repo/cli build

# Development for specific packages
pnpm --filter=web dev
pnpm --filter=docs dev

πŸ—οΈ Project Structure

harukit-ui/
β”œβ”€β”€ apps/
β”‚   β”œβ”€β”€ docs/              # Documentation site
β”‚   └── web/               # Main web application
β”œβ”€β”€ packages/
β”‚   β”œβ”€β”€ cli/               # CLI tool for component generation
β”‚   β”œβ”€β”€ eslint-config/     # Shared ESLint configuration
β”‚   β”œβ”€β”€ typescript-config/ # Shared TypeScript configuration
β”‚   └── ui/                # Core component library
β”œβ”€β”€ turbo.json             # Turborepo configuration
β”œβ”€β”€ package.json           # Root package.json
└── pnpm-workspace.yaml    # pnpm workspace configuration

πŸ”§ Development

Adding New Components

  1. Using the CLI tool:

    pnpm cli:build
    pnpm --filter=@repo/cli generate component Button

Building for Production

# Build all packages and apps
pnpm build

# Build specific packages
pnpm --filter=@repo/ui build
pnpm --filter=docs build

πŸ“– Documentation

  • Component Library: Visit the docs site at http://localhost:3001
  • CLI Usage: See packages/cli/README.md for CLI documentation

🀝 Contributing

We welcome contributions! Please see our Contributing Guide for details on how to:

  • Set up your development environment
  • Submit bug reports and feature requests
  • Contribute code and documentation
  • Follow our coding standards

πŸ“„ License

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

πŸ†˜ Support

πŸ”— Useful Links


Made with ❀️ by the Harukit UI team

About

✨ A modern, minimal, 🧩 headless UI component library for React βš›οΈ β€” built with Radix UI πŸ—‚οΈ, styled using Tailwind CSS πŸ’¨

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 57.2%
  • MDX 38.0%
  • CSS 2.5%
  • JavaScript 1.2%
  • Other 1.1%