New

5 demos, 10+ applications, 50+ blocks, 30+ pages & much more

Documentation

Browse and explore docs

Quick Start

1. Requirements

Before proceeding, you need to have the latest stable version of Node.js installed.

Recommended environment:

  • Node.js (latest LTS)
  • npm or yarn

2. Installation

Open the package folder and install its dependencies. We recommend yarn or npm.

ScriptCommand
Install npm
cd project-folder
npm install
Start
npm run dev
Build
npm run build

3. Theming

shadcndashboard offers both light and dark style options, with the light style set as the default.

By default we provide 2 color themes. Change the activeMode attribute in config.ts:

lightdark
activeMode: "light",

4. RTL Supported

shadcndashboard comes with built-in RTL support by default.

To enable RTL direction, set activeDir: "rtl" in config.ts:

ltrrtl
activeDir: "rtl",