shadcn-admin README

The project's README from github.com/satnaing/shadcn-admin. As one markdown file: README.md.

Shadcn Admin Dashboard

Admin Dashboard UI crafted with Shadcn and Vite. Built with responsiveness and accessibility in mind.

alt text

Sponsored by Clerk

I've been creating dashboard UIs at work and for my personal projects. I always wanted to make a reusable collection of dashboard UI for future projects; and here it is now. While I've created a few custom components, some of the code is directly adapted from ShadcnUI examples.

This is not a starter project (template) though. I'll probably make one in the future.

Features

Customized Components (click to expand)

This project uses Shadcn UI components, but some have been slightly modified for better RTL (Right-to-Left) support and other improvements. These customized components differ from the original Shadcn UI versions.

If you want to update components using the Shadcn CLI (e.g., npx shadcn@latest add <component>), it's generally safe for non-customized components. For the listed customized ones, you may need to manually merge changes to preserve the project's modifications and avoid overwriting RTL support or other updates.

If you don't require RTL support, you can safely update the 'RTL Updated Components' via the Shadcn CLI, as these changes are primarily for RTL compatibility. The 'Modified Components' may have other customizations to consider.

Modified Components

  • scroll-area
  • sonner
  • separator

RTL Updated Components

  • alert-dialog
  • calendar
  • command
  • dialog
  • dropdown-menu
  • select
  • table
  • sheet
  • sidebar
  • switch

Notes:

  • Modified Components: These have general updates, potentially including RTL adjustments.
  • RTL Updated Components: These have specific changes for RTL language support (e.g., layout, positioning).
  • For implementation details, check the source files in src/components/ui/.
  • All other Shadcn UI components in the project are standard and can be safely updated via the CLI.

Tech Stack

UI: ShadcnUI (TailwindCSS + RadixUI)

Build Tool: Vite

Routing: TanStack Router

Type Checking: TypeScript

Linting/Formatting: ESLint & Prettier

Icons: Lucide Icons, Tabler Icons (Brand icons only)

Auth (partial): Clerk

Run Locally

Clone the project

  git clone https://github.com/satnaing/shadcn-admin.git

Go to the project directory

  cd shadcn-admin

Install dependencies

  pnpm install

Start the server

  pnpm run dev

Sponsoring this project ❤️

If you find this project helpful or use this in your own work, consider sponsoring me to support development and maintenance. You can buy me a coffee as well. Don’t worry, every penny helps. Thank you! 🙏

For questions or sponsorship inquiries, feel free to reach out at [email protected].

Current Sponsor

Author

Crafted with 🤍 by @satnaing

License

Licensed under the MIT License

shadcn-admin (satnaing/shadcn-admin)

shadcn-ui
Searching Database…

15.8K ·GitHub
Shadcn-admin
What is this?An open-source admin dashboard UI built with Shadcn UI (TailwindCSS + Radix) and Vite — a reusable collection of dashboard screens the author adapts for his own projects.
Is this a starter template I can scaffold from, or a finished dashboard?It is a complete, cloneable web app rather than a scaffold. The author explicitly notes it is not a starter template, though he may turn it into one in the future.
How do I get it running locally?Clone the repo, enter the directory, install dependencies and start the Vite dev server (npm run dev). Scripts for build, preview, lint, formatting and Vitest tests are included too.
What is it built on — do I need anything special like an auth account?A Vite + React stack: Shadcn UI (TailwindCSS + Radix UI), TanStack Router, TypeScript, ESLint/Prettier and Lucide/Tabler icons. Auth is partially wired to Clerk, so that part expects a Clerk setup.
Can I safely update the Shadcn components with the Shadcn CLI?Mostly, but not blindly. A few components (scroll-area, sonner, separator) are modified and ten others carry RTL fixes, so updating those via the CLI may require manual merging to keep the changes.
What do I get out of the box?10+ pages with a built-in sidebar and a global search command, light/dark mode, RTL support and extra custom components — all responsive and accessible.
Why did the author build this?He kept creating dashboard UIs for work and personal projects and wanted a reusable collection to lean on for future projects instead of starting over each time.
Is there any testing or code-quality tooling?Yes. The repo ships Vitest browser tests plus ESLint and Prettier scripts, and knip for spotting unused code.
What are similar projects?vuestic-admin, arc-library, AdminLTE, tabler, Monocharts, ui, gentelella, full-stack-fastapi-template
Which topics is it in?command-palette, tanstack-router, admin-panel, shadcn, shadcn-ui, responsive, admin-dashboard, dark-mode, accessibility, tailwindcss, vite, component-library
Creator
satnaing
Size
2.9 MB
Stars
15.8K
Updated
CommitJun 11Releasev2.2.1Nov 06
Age
2y
Commits · 90 Days