diff --git a/README.md b/README.md index 0a1031ff..ad44294e 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,71 @@ Soybean Admin 是一个基于 Vue3、Vite、TypeScript、Naive UI 的免费中 - **主题**:丰富可配置的主题、暗黑模式,基于windicss的动态主题颜色 - **代码规范**:丰富的规范插件及极高的代码规范 - **权限路由**:简易的路由配置、基于mock的动态路由能快速实现后端动态路由 -- **请求函数**:完善的请求函数封装,提供Promise和hooks两种请求函数 +- **请求函数**:基于axios的完善的请求函数封装 + +## 特性细节 + +- **技术栈**: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. 支持各种主题颜色、暗黑模式和各种布局 + 1. WindiCss引入各种主题颜色,直接通过class即可应用对应的颜色 + 2. 初始化加载适应主题颜色 + 3. 支持项目logo自适应主题颜色 + +- **请求函数**:基于axios封装 + + 1. 请求实例:可创建多个不同的baseUrl的请求实例 + + 2. 统一请求结果:将错误信息统一处理成特定格式,和请求成功的数据再按特定格式一起返回 + + ```typescript + interface ServiceResult { + data: T | null, + error: ServiceError | null + } + ``` + + 3. 错误提示:智能提示错误,避免同一种错误在同一时间段显示,通过指定错误码不展示响应错误 + + 4. token刷新:无感刷新token + + 5. 请求参数转换:根据不同的Content-Type转换数据,利用qs序列化数据,支持单文件和多文件上传 + + 1. 封装的请求函数支持promise和hooks两种 + +- **自定义组件** + + 1. 布局组件soybean-layout: + - 分为header、tab、sider、content、footer五个部分,除了content,其余都可以控制显示隐藏,且可以自定义过度动画 + - 支持vertical和horizontal两种模式,结合局部的现实隐藏,为该项目提供了4种布局模式 + - 高性能组件,相比用UI组件构建的布局,该组件属于定制化,不用考虑很多因素 + 2. 多页签组件:ChromeTab和ButtonTab + - 支持主题颜色及暗黑模式 + - ChromeTab类似于浏览器的标签,样式清新 + - 结合BetterScroll,实现多页签组件的左右鼠标滑动(移动端左右触摸滑动),激活状态的Tab自动居中 + 3. LoadingEmptyWrapper + - 支持现实加载状态、空状态和网络状态的组件 + - 支持主题颜色及暗黑模式 + - 图片文字大小通过属性配置 ## 预览 @@ -44,11 +108,9 @@ Soybean Admin 是一个基于 Vue3、Vite、TypeScript、Naive UI 的免费中 ![](https://s2.loli.net/2022/01/24/wXpHeau6UrSTWdF.png) -### 使用 Gitpod +![](https://s2.loli.net/2022/02/16/bWeIp5k1GXoRziM.png) -在 Gitpod(适用于 GitHub 的免费在线开发环境)中打开项目,并立即开始编码. - -[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/honghuangdc/soybean-admin) +![](https://s2.loli.net/2022/02/16/pfuxVEPsTJIXw5n.png) ## 安装使用