Skip to content

EqualExperts/kuat-mono

Repository files navigation

Kuat Design System

A comprehensive design system for Equal Experts, providing React and Vue component libraries built on shadcn/ui and shadcn-vue, with centralized design tokens for brand consistency across applications.

What is Kuat?

Kuat is Equal Experts' design system that:

  • Provides ready-to-use component libraries for React and Vue applications
  • Ensures brand consistency through centralized design tokens and CSS variables
  • Accelerates development with pre-built, accessible components
  • Built on industry standards using shadcn/ui, shadcn-vue, and Tailwind CSS v4
  • Published to npm as @equal-experts/kuat-react and @equal-experts/kuat-vue

The design system includes brand color palettes (EE Blue, Tech Blue, Transform Teal, Equal Ember), typography scales, spacing systems, and a growing library of accessible UI components.

Structure

packages/
├── kuat-core/     # Shared CSS variables and Tailwind configuration
├── kuat-react/    # React component library using shadcn/ui
└── kuat-vue/      # Vue component library using shadcn-vue

apps/
├── storybook-react/  # Interactive component documentation for React
└── storybook-vue/    # Interactive component documentation for Vue

Getting Started

For Application Developers

If you want to use the Kuat Design System in your React or Vue application:

For Contributors

If you want to develop components for the Kuat Design System:

  1. Prerequisites

    • Node.js >= 18
    • pnpm >= 8
  2. Clone and Install

    git clone <repository-url>
    cd kuat-mono
    pnpm install
  3. Start Development

    # Start React Storybook (http://localhost:6006)
    pnpm --filter storybook-react dev
    
    # Start Vue Storybook (http://localhost:6007)
    pnpm --filter storybook-vue dev
  4. Read the Contributor Guide

Quick Commands

# Build all packages
pnpm build

# Lint all packages
pnpm lint

# Run all packages in development mode
pnpm dev

Project Status

Current Version: 0.2.x

Available Components:

  • Button (with variants: default, destructive, outline, secondary, ghost, link)
  • Accordion (single and multiple selection modes)
  • Alert Dialog (with customizable actions)

Coming Soon:

  • Form components (Input, Select, Checkbox, Radio)
  • Navigation components (Tabs, Menu, Breadcrumb)
  • Feedback components (Toast, Alert, Progress)
  • And more...

Packages

@equal-experts/kuat-core

Shared CSS variables and Tailwind configuration for consistent theming across React and Vue packages.

Key Features:

  • Brand color palettes (EE Blue, Tech Blue, Transform Teal, Equal Ember)
  • Typography system (Lexend, Lora, JetBrains Mono)
  • Spacing and layout utilities
  • Dark mode support

@equal-experts/kuat-react

React component library built with shadcn/ui, Radix UI primitives, and Tailwind CSS v4.

Installation: pnpm add @equal-experts/kuat-react

Usage Guide: See packages/kuat-react/README.md for integration instructions.

@equal-experts/kuat-vue

Vue component library built with shadcn-vue, Radix Vue primitives, and Tailwind CSS v4.

Installation: pnpm add @equal-experts/kuat-vue

Usage Guide: See packages/kuat-vue/README.md for integration instructions.

Tech Stack

  • Monorepo: Turborepo
  • Package Manager: pnpm workspaces
  • Styling: Tailwind CSS v4
  • React: shadcn/ui
  • Vue: shadcn-vue
  • Build Tool: Vite
  • Documentation: Storybook 8

Documentation

For Users

For Contributors

For Maintainers

  • PUBLISHING.md - Publishing packages to npm
  • Version management and release process

For AI Agents

Contributing

We welcome contributions! Please read CONTRIBUTING.md for:

  • Development environment setup
  • Adding new components
  • Creating Storybook stories
  • Submitting pull requests

License

[License information to be added]

About

No description, website, or topics provided.

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published