next-shadcn-dashboard-starter

英文原文正文为项目原始 README（英文），本站后续会翻译为中文，当前仅剔除图片与无关章节并统一排版。

Admin Dashboard Template with Next.js & Shadcn UI

Overview

A free, open source (MIT) admin dashboard starter built with Next.js 16, shadcn/ui on Base UI primitives, TypeScript, and Tailwind CSS v4.

Every feature is a working, production-ready implementation, not static demo UI. Tables search, filter, sort, and paginate for real. Forms validate and mutate with cache invalidation. Auth, organizations, and billing function end-to-end.

Clone it, strip what you don't need with the built-in cleanup script, and start building on patterns you'd write yourself. It works well as a base for SaaS apps, internal tools, and admin panels.

Why This Template

Most dashboard templates are static demo boilerplates: screens that look finished but need rebuilding the moment you wire in real data. This starter takes the opposite approach:

• Everything actually works. Data tables run end-to-end: server prefetch, client-side React Query cache, and URL-synced search, filtering, sorting, and pagination via nuqs. Forms are built from reusable, composable fields with Zod validation, including advanced patterns like multi-step and dialog/sheet forms, with real create/update mutations and cache invalidation on success.
• Industry-standard implementations. The data layer follows the official TanStack Query SSR pattern (server prefetch + HydrationBoundary + useSuspenseQuery), typed end to end, organized in a feature-based structure with a clean API layer per feature. These are patterns you copy into production code as-is, not mockups you rebuild from scratch.
• Minimal by design. Deliberately lean, with no bloated boilerplate, so you spend your time tweaking it to your use case, not deleting someone else's code. The built-in cleanup script strips any feature you don't need in under a minute.

Tech Stack

• Framework - Next.js 16
• Language - TypeScript
• Auth - Clerk
• Error tracking - Sentry
• Styling - Tailwind CSS v4
• Components - shadcn/ui on Base UI primitives
• Charts - Recharts • Evil Charts
• Schema validation - Zod
• Data fetching - TanStack React Query
• State management - Zustand
• Search param state - Nuqs
• Tables - TanStack Data Tables • Dice Table
• Forms - TanStack Form + Zod
• Command+K interface - kbar
• Linter / Formatter - OxLint • Oxfmt
• Pre-commit hooks - Husky
• Themes - tweakcn

Looking for a TanStack Start version? Here's the repo.

Features

• Pre-built dashboard layout with sidebar, header, and content area
• Analytics overview page with cards and charts
• Data tables with React Query prefetch, client-side cache, search, filter, and pagination
• Authentication and user management through Clerk
• Multi-tenant workspaces using Clerk Organizations (create, switch, manage teams)
• Billing and subscriptions via Clerk Billing for B2B, with plan management and feature gating
• Client-side RBAC navigation that filters menu items by organization, permissions, and roles
• Infobar component for tips, status messages, or contextual notes on any page
• shadcn/ui components on Base UI primitives, styled with Tailwind CSS
• Six-plus themes with a theme switcher
• Feature-based folder structure
• A starting point for SaaS dashboards, internal tools, and client admin panels

Use Cases

A few things you can build with it:

• SaaS admin dashboards
• Internal tools and operations panels
• Analytics dashboards
• Client project admin panels
• A boilerplate for new Next.js shadcn projects

Pages

Folder Structure

src/
├── app/                           # Next.js App Router directory
│   ├── auth/                      # Auth pages (sign-in, sign-up)
│   ├── dashboard/                 # Dashboard route group
│   │   ├── overview/              # Analytics with parallel routes
│   │   ├── product/               # Product CRUD pages (React Query)
│   │   ├── users/                 # Users table (React Query + nuqs)
│   │   ├── react-query/           # React Query demo page
│   │   ├── kanban/                # Task board page
│   │   ├── chat/                  # Messaging page
│   │   ├── ai-chat/               # AI chat streaming demo
│   │   ├── notifications/         # Notifications page
│   │   ├── workspaces/            # Org management & teams
│   │   ├── billing/               # Billing & plans
│   │   ├── profile/               # User profile
│   │   └── exclusive/             # Plan-gated page
│   └── api/                       # API routes
│
├── components/                    # Shared components
│   ├── ui/                        # UI primitives (buttons, inputs, dialogs, etc.)
│   ├── layout/                    # Layout components (header, sidebar, etc.)
│   ├── themes/                    # Theme system (selector, mode toggle, config)
│   └── kbar/                      # Command+K interface
│
├── features/                      # Feature-based modules
│   ├── overview/                  # Dashboard analytics (charts, cards)
│   ├── products/                  # Product listing, form, tables (React Query)
│   ├── users/                     # User management table (React Query)
│   ├── react-query-demo/          # React Query demo (Pokemon API)
│   ├── kanban/                    # Drag-drop task board
│   ├── chat/                      # Messaging (conversations, bubbles, composer)
│   ├── ai-chat/                   # Scripted useChat streaming demo (shadcn chat UI)
│   ├── notifications/             # Notification center & store
│   ├── auth/                      # Auth components
│   └── profile/                   # Profile form schemas
│
├── lib/                           # Core utilities (query-client, searchparams, etc.)
├── hooks/                         # Custom hooks
├── config/                        # Navigation, infobar, data table config
├── constants/                     # Mock data
├── styles/                        # Global CSS & theme files
│   └── themes/                    # Individual theme CSS files
└── types/                         # TypeScript types

Getting Started

Clone the repo:

git clone https://github.com/Kiranism/next-shadcn-dashboard-starter.git

• bun install
• Copy the example env file: cp env.example.txt .env.local
• Fill in the required variables in .env.local
• bun run dev

Environment variables

See env.example.txt for the variables you need. They cover authentication and error tracking.

Clerk setup

For setting up Clerk auth (including organizations, workspaces, and teams), see clerk_setup.md.

The app should now be running at http://localhost:3000.

Cleanup Script: Start Minimal in 60 Seconds

Most starters make you hand-delete demo pages and rip out dependencies. This one ships with a cleanup script that removes the optional features you don't need (folders, files, dependencies, docs, and env entries), leaving a minimal base to build on. Run --list to see what's removable:

bun run cleanup --interactive    # interactive mode
bun run cleanup --list           # see available features
bun run cleanup --dry-run chat   # preview before removing
bun run cleanup kanban chat      # remove specific features

Run bun run cleanup --help for all options (with npm, pass flags after --: npm run cleanup -- --list). The replacement files it writes live in scripts/cleanup-templates/ as real, typechecked code. When you're done, delete scripts/cleanup.js, scripts/cleanup-templates/, and the cleanup entry in package.json.

FAQ

Is it production ready? Yes. Every feature is a complete, working implementation: authentication, CRUD flows, table search/filter/sort/pagination, and form validation with mutations all function end-to-end. It's a starting point for real applications, not a visual mockup.

How is this different from other dashboard templates? Most dashboard templates are static demo boilerplates: screens that look finished but need rebuilding once you wire in real data. Here the tables, forms, auth, organizations, and billing all work end-to-end, the implementations follow official TanStack and Next.js patterns, and a cleanup script keeps the base minimal so you tweak it to your use case instead of deleting code.

Is it free for commercial use? Yes. MIT-licensed and free for both personal and commercial projects: no paid tier, no license keys.

Can I use it without Clerk? Yes. Run bun run cleanup clerk to remove Clerk authentication (along with organizations and billing) and wire in your own auth solution.

How do I remove demo pages or features I don't need? Run bun run cleanup --interactive and pick what to strip, or bun run cleanup --list to see what can be removed.

Does it support Next.js 16, React 19, and Tailwind CSS v4? Yes. The template is built on Next.js 16 (App Router), React 19, and Tailwind CSS v4, with shadcn/ui on Base UI primitives, and is actively maintained to track new releases.

Can I use npm instead of Bun? Yes. Bun is preferred, but npm works too, and the repo even ships both Node.js and Bun Dockerfiles for deployment.

Does it work with AI coding assistants? Yes. The repo ships AGENTS.md and CLAUDE.md with the project's conventions, plus a bundled Claude Code skill (.claude/skills/kiranism-shadcn-dashboard) that teaches agents how to add pages, tables, forms, and navigation the template way. Works with Claude Code, Cursor, and any tool that reads AGENTS.md.

What data fetching pattern does it use? TanStack React Query with the official SSR pattern: queryClient.query() prefetch on the server, HydrationBoundary with dehydrate for hydration, and useSuspenseQuery on the client, plus nuqs for URL-synced search-param state. Mutations invalidate the cache on success.

How do I deploy it? Deploy to Vercel out of the box, or use the included Docker setups: a Node.js Dockerfile and a Bun Dockerfile, both using Next.js standalone output mode. See the deployment guide.

Deploy

Deploy to Vercel out of the box, or use the included Docker setups: a Node.js Dockerfile and a Bun Dockerfile, both using Next.js standalone output mode. Full guide: docs/deployment.md.

Support

If this template saved you some time, a star is appreciated. You can also buy me a coffee if you'd like.