1. Components
  2. installation

Installation

Get started with JK-UI in your React project

Installation

Prerequisites

Before you begin, make sure you have:
  • Node.js 18+ installed
  • A React project (TanStack Start, Vite, Next.js, RasenganJS, or similar)
  • A package manager (npm, yarn, pnpm, or bun)

Initialize JK-UI

Run the JK-UI CLI to set up your project:
terminal
bunx jk-ui@latest init
The CLI will guide you through the setup:
  • Theme Mode: Choose between light-only, dark-only, or light/dark toggle
  • Icon Library: Select your preferred icon library
  • CSS Setup: Automatic TailwindCSS v4 configuration
  • Utilities: Add JK-UI utility classes and CSS variables
  • shadcn-cli: Add shadcn-cli to your project

Add Components

After initialization, add components using the shadcn-cli:
terminal
bunx shadcn@latest add @jk-ui/button @jk-ui/card @jk-ui/input

CLI Reference

For detailed CLI commands and options, see the CLI documentation.

Next Steps

Prev
Dark Mode

Implementing and toggling dark mode support in your Laravel application.

Next
On this page