前言
大约 3 分钟
介绍
简介
Vue-Vben-Admin 是一个基于 Vue3.0、Vite、 Ant-Design-Vue、TypeScript 的后台解决方案,目标是为开发中大型项目提供开箱即用的解决方案。包括二次封装组件、utils、hooks、动态菜单、权限校验、按钮级别权限控制等功能。项目会使用前端较新的技术栈,可以作为项目的启动模版,以帮助你快速搭建企业级中后台产品原型。也可以作为一个示例,用于学习 vue3
、vite
、ts
等主流技术。该项目会持续跟进最新技术,并将其应用在项目中。
文档
- 中文文档地址为 vben-admin-doc,采用 Vitepress 开发。如发现文档有误,欢迎提 pr 帮助我们改进。
- 英文文档暂时没有时间来写,欢迎有时间的同学来帮忙写英文文档。
本地运行文档
如需本地运行文档,请拉取代码到本地。
# 拉取代码
git clone https://github.com/vbenjs/vue-vben-admin-doc
# 安装依赖
pnpm
# 运行项目
pnpm dev
需要掌握的基础知识
本项目需要一定前端基础知识,请确保掌握 Vue 的基础知识,以便能处理一些常见的问题。 建议在开发前先学一下以下内容,提前了解和学习这些知识,会对项目理解非常有帮助:
模版
该版本主要是提供一些 Demo
示例及插件的使用集成方式,主要用于参考。如果对项目不是很熟悉,不建议在此基础上进行开发,请使用下方提供的精简版本。
vue-vben-admin
精简版本。删除了相关示例、无用文件及功能、依赖。可以根据自身需求安装对应的依赖。因为使用的是 vite
,依赖删除不会导致相关组件或者 hook
发出警告。只在需要的时候安装对应的库即可。
vite 插件推荐
如果这些插件对你有帮助,可以给一个 star 支持下
- vite-plugin-mock - 用于本地及开发环境数据
mock
- vite-plugin-html - 用于
html
模版转换,可以在html
文件内进行书写模版语法 - vite-plugin-style-import - 用于组件库样式按需引入
- vite-plugin-imagemin - 用于打包压缩图片资源
- vite-plugin-theme - 用于在线切换主题色/黑暗主题适配等主题相关配置
- vite-plugin-compression - 用于打包输出
.gz
|.br
文件 - vite-plugin-svg-icons - 快速生成
svg sprite
浏览器支持
本地开发推荐使用Chrome 最新版
浏览器,不支持Chrome 80
以下版本。
生产环境支持现代浏览器,不支持 IE。
IE | Edge | Firefox | Chrome | Safari |
---|---|---|---|---|
not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
如何加入我们
- Vue-Vben-Admin 还在持续更新中,本项目欢迎您的参与,共同维护,逐步完善,将项目做得更强。同时整个项目本着一切免费的原则,原则上不会收取任何费用及版权,可以放心使用。
- 如果你想加入我们,可以多提供一些好的建议或者提交 pr,我们会根据你的活跃度邀请你加入。