README-CN.md

Shadcn Vue Admin

Forked from shadcn-admin

管理仪表板 UI 采用 Shadcn-vue、Vue3 和 Vite 精心打造。构建时充分考虑了响应能力和可访问性。

这是一个起始（模板）项目，后续会增加更多组件。

特性

• 亮色|暗色模式
• 全局搜索命令
• shadcn-ui 侧边栏
• 8+ 页面
• 精美的自定义组件
• 自动生成路由

技术栈

ui:

• inspira-ui
• shadcn-vue

Build Tool:

• Vite

State Management:

• pinia
• persistedstate

Styling:

• Tailwind CSS

Unplugins:

• Auto Import
• Components
• vite-plugin-pages [弃用]
• unplugin-vue-router
• Vite Plugin Vue Layouts
• Vite Plugin Vue Devtools

Icons:

• Lucide

Linting:

• ESLint
• antfu/eslint-config

Charts:

• vue-chrts

  如果您使用 tailwindcss v4，shadcn-vue charts 已被标记为 'Legacy'。我们现在使用这个库来替代它。

本地运行

克隆项目至本地

git clone https://github.com/Whbbit1999/shadcn-vue-admin.git

进入项目所在目录

cd shadcn-vue-admin

安装依赖

pnpm install

启动项目

pnpm dev

Tips

主题定制

如果您需要更改网站样式，可以使用tweakcn网站提供的预设样式。你只需要将 tweakcn 提供的 css 样式 复制到 index.css 中，改动 :root :dark 和 @theme inline 部分即可。

在嵌套目录中没有 index.vue 且不想使用默认的布局

比如，我不想让 pages/errors/ 和 pages/auth/ 文件夹中的页面使用默认的布局， 我需要在 pages/ 中创建一个与目录同名的文件，src/pages/errors.vue src/pages/auth.vue，文件内容如下。

<template>
  <router-view />
</template>

<route lang="yml">
meta:
  layout: false # 这里是你要的布局，我这里使用 false 表示它不用布局组件
</route>

这会导致多生成一个路由，这个示例中，如果你根据上述步骤操作后，会生成多余的 /error/ 和 /auth/ 路由，并且这两个页面会是空白页。 如果你不需要它们，且该目录下没有 index.vue，可以在目录中创建一个 index.vue文件并将其重定向至任何页面。 我这里统一将其重定向至 /errors/404，你可以根据你的情况自己处理。其中 index.vue文件的内容如下：

<script lang="ts" setup>
const router = useRouter()
router.replace({ name: '/errors/404' })
</script>

作者

由 Whbbit创建, 设计来自 shadcn-admin

许可证

MIT