博文:
https://juejin.cn/post/7049196967770980389
开源协议:MIT
开源地址:
https://github.com/honghuangdc/soybean-admin
本地环境需要安装
pnpm 6.x 、Node.js 14.x 和 Git
克隆代码
git clone https://github.com/honghuangdc/soybean-admin.git
安装依赖
pnpm i
运行
pnpm dev
打包
pnpm build
基于 Vue3的开源中后台模版,内置丰富可配置的主题
2022-04-19 00:01·GitHub精选
《开源精选》是我们分享Github、Gitee等开源社区中优质项目的栏目,包括技术、学习、实用与各种有趣的内容。本期推荐的是一个个基于 Vue3、Vite、TypeScript、Naive UI 的中后台模版——Soybean Admin。
基于 Vue3的开源中后台模版,内置丰富可配置的主题
Soybean Admin 是一个基于 Vue3、Vite、TypeScript、Naive UI 的免费中后台模版,它使用了最新的前端技术栈,内置丰富的主题配置,有着极高的代码规范,基于mock实现的动态权限路由,开箱即用的中后台前端解决方案,也可用于学习参考。
功能特性
最新技术栈:基于Vue3、Vite、Naive UI、TypeScript等最新技术栈开发
极高水准的代码规范:代码规范完善,代码结构清晰
丰富的插件:常见的Web端插件示例实现
组件封装:对使用频率较高的UI组件进行二次封装,满足更多业务需求
主题配置:丰富的主题配置及黑暗主题适配
权限管理:完善的前后端权限管理方案
特性细节
技术栈
Vite2 + Vue3 + TypeScript + NaiveUI + Pinia + WindiCss + Axios + AntV + @vueuse + iconify
严格的代码规范
1、eslint + prettier + eslint-config-airbnb-base + eslint-plugin-vue + eslint-plugin-import + @
typescript-eslint/eslint-plugin等插件提供代码全面的格式规范,eslintrc的 import/order 规则规范了导入依赖的顺序
2、husky + lint-staged + vuetsc + commitlint + commitizen 保证了提交的代码符合eslint规则和TS类型检测,提交的内容规范遵循了angular提交规范
3、应用设计模式优化代码:项目里面多次用到策略模式替换if else
4、所有页面使用script-setup写法,并遵循特定顺序(用文档规范)
5、目录结构组织遵循特定规范,页面的写法严格遵循模块思想,使得每个页面的代码结构清晰明了
权限路由
1、动态的路由数据由mock生成,前端添加动态路由
2、指定了mock路由的类型,方便快速对接后端
3、菜单由动态路由数据生成,支持隐藏指定菜单,支持多级菜单,支持外链打开
4、在多页签中的缓存的页面会记录滚动位置
5、面包屑数据由当前路由和菜单数据生成
主题
1、支持各种主题颜色、暗黑模式和各种布局
2、WindiCss引入各种主题颜色,直接通过class即可应用对应的颜色
3、初始化加载适应主题颜色
4、支持项目logo自适应主题颜色
请求函数:基于axios封装
1、请求实例:可创建多个不同的baseUrl的请求实例
2、统一请求结果:将错误信息统一处理成特定格式,和请求成功的数据再按特定格式一起返回
interface ServiceResult
data: T | null,
error: ServiceError | null
}
3、错误提示:智能提示错误,避免同一种错误在同一时间段显示,通过指定错误码不展示响应错误
4、token刷新:无感刷新token
5、请求参数转换:根据不同的Content-Type转换数据,利用qs序列化数据,支持单文件和多文件上传
6、封装的请求函数支持promise和hooks两种, hooks的请求函数包含loading状态
自定义组件
1、布局组件soybean-admin-layout:
分为header、tab、sider、content、footer五个部分,除了content,其余都可以控制显示隐藏,且可以自定义过度动画
支持vertical和horizontal两种模式,结合局部的现实隐藏,为该项目提供了4种布局模式
高性能组件,相比用UI组件构建的布局,该组件不用考虑很多因素,专注于当前的几种布局模式
2、多页签组件soybean-admin-tab:ChromeTab和ButtonTab
支持主题颜色及暗黑模式
ChromeTab类似于浏览器的标签,样式清新
结合BetterScroll,实现多页签组件的左右鼠标滑动(移动端左右触摸滑动),激活状态的Tab自动居中
3、LoadingEmptyWrapper
支持现实加载状态、空状态和网络状态的组件
支持主题颜色及暗黑模式
图片文字大小通过属性配置
项目截图