提交 | 用户 | age
|
351f60
|
1 |
<p align="center"> |
陈 |
2 |
<a href="https://github.com/anncwb/vue-vben-admin" target="_blank"> |
afbcf0
|
3 |
<img alt="VbenAdmin Logo" width="200" src="./.github/res/imgs/logo.png"> |
351f60
|
4 |
</a> |
陈 |
5 |
</p> |
afbcf0
|
6 |
<h2 align="center">VUE VBEN ADMIN2.0</h2> |
351f60
|
7 |
|
afbcf0
|
8 |
**中文** | [English](./README-ES.md) |
351f60
|
9 |
|
陈 |
10 |
[更新日志](CHANGELOG.md) |
|
11 |
|
afbcf0
|
12 |
- [介绍](#介绍) |
V |
13 |
- [gitHub 地址](#github-地址) |
|
14 |
- [预览地址](#预览地址) |
|
15 |
- [文档](#文档) |
|
16 |
- [预安装](#预安装) |
|
17 |
- [环境要求](#环境要求) |
|
18 |
- [UI 框架](#ui-框架) |
|
19 |
- [图标](#图标) |
|
20 |
- [插件](#插件) |
351f60
|
21 |
- [建议开发环境](#建议开发环境) |
陈 |
22 |
- [安装](#安装) |
afbcf0
|
23 |
- [使用](#使用) |
V |
24 |
- [开发环境](#开发环境) |
351f60
|
25 |
- [打包](#打包) |
陈 |
26 |
- [格式化](#格式化) |
|
27 |
- [其他](#其他) |
|
28 |
- [Git 提交规范](#git-提交规范) |
|
29 |
- [代码贡献](#代码贡献) |
afbcf0
|
30 |
- [已完成功能](#已完成功能) |
V |
31 |
- [正在开发的功能](#正在开发的功能) |
351f60
|
32 |
- [加入我们](#加入我们) |
陈 |
33 |
|
afbcf0
|
34 |
## 介绍 |
351f60
|
35 |
|
afbcf0
|
36 |
该分支为 2.0 新分支,使用 vue3 进行开发。 |
V |
37 |
|
|
38 |
1.0 分支请切换到`master`分支。1.0 采用`vue2.6`+`vue-composition-api`+`vue-cli`开发 |
|
39 |
|
|
40 |
项目基于`ant-design-vue`,`typescript`,`vue3.0`,`vite`,`tailwindcss`,`tsx`实现的 vue3 风格的后台管理系统, |
|
41 |
|
|
42 |
## gitHub 地址 |
|
43 |
|
|
44 |
[vue-vben-admin2.0](https://github.com/anncwb/vue-vben-admin) - `main` 分支 |
|
45 |
|
|
46 |
## 预览地址 |
|
47 |
|
|
48 |
[2.0 在线预览](https://vvbin.cn/next/) |
|
49 |
|
03b602
|
50 |
测试账号: vben/123456 |
N |
51 |
|
afbcf0
|
52 |
<p align="center"> |
V |
53 |
<img alt="VbenAdmin Logo" width="100%" src="./.github/res/imgs/preview1.png"> |
|
54 |
<img alt="VbenAdmin Logo" width="100%" src="./.github/res/imgs/preview2.png"> |
|
55 |
<img alt="VbenAdmin Logo" width="100%" src="./.github/res/imgs/preview3.png"> |
|
56 |
</p> |
|
57 |
|
|
58 |
## 文档 |
|
59 |
|
|
60 |
2.0 文档还没开始写。后续补上。 |
|
61 |
|
|
62 |
## 预安装 |
|
63 |
|
|
64 |
### 环境要求 |
|
65 |
|
|
66 |
- `Node.js`: - 版本最好大于 `12.0.0` |
|
67 |
- `yarn` > `npm` > `cnpm`: - 包管理工具. |
|
68 |
|
|
69 |
### UI 框架 |
|
70 |
|
21d0ed
|
71 |
- [Tailwind CSS](https://tailwindcss.com/) - 2.0.0-beta.5 已删除 |
afbcf0
|
72 |
- [Ant Design Vue 2.0](https://2x.antdv.com/docs/vue/introduce-cn/) |
V |
73 |
|
|
74 |
### 图标 |
|
75 |
|
|
76 |
- [Ant Design Vue Icon Component](https://2x.antdv.com/components/icon-cn/) - 按需引入所需图标. |
|
77 |
- [Iconify](https://iconify.design) - 使用任何图标集中的图标 [Icônes](https://icones.netlify.app/) |
|
78 |
- [PurgeIcons](https://github.com/antfu/purge-icons) - 仅打包所使用到的图标. |
|
79 |
|
|
80 |
### 插件 |
|
81 |
|
|
82 |
- [Vue Router Next](https://github.com/vuejs/vue-router-next) |
|
83 |
- [Vuex Next](https://github.com/vuejs/vuex) |
|
84 |
- [vuex-module-decorators](https://github.com/championswimmer/vuex-module-decorators) - vuex 模块化 |
|
85 |
- [vite-plugin-mock](https://github.com/anncwb/vite-plugin-mock) - 基于 vite 的 mock 插件. |
|
86 |
- [vue-i18n](https://github.com/intlify/vue-i18n-next) - 国际化 |
|
87 |
- [lodash-es](https://github.com/lodash/lodash) - JavaScript 实用程序库 |
|
88 |
- [moment](https://github.com/moment/moment) - 时间操作库 |
|
89 |
- [axios](https://github.com/axios/axios) - Http 数据交互 |
|
90 |
- [TypeScript](https://www.typescriptlang.org/) |
351f60
|
91 |
|
陈 |
92 |
### 建议开发环境 |
|
93 |
|
afbcf0
|
94 |
- `Git`: - 版本管理工具 |
V |
95 |
- `Visual Studio Code` - (VSCode): 最新版本 |
|
96 |
- [VS Code Extensions](./.vscode/extensions.json) |
|
97 |
- [Iconify IntelliSense](https://marketplace.visualstudio.com/items?itemName=antfu.iconify) |
|
98 |
- [Tailwind CSS IntelliSense](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss) - Tailwind Css 样式联想 |
|
99 |
- [Vetur](https://marketplace.visualstudio.com/items?itemName=octref.vetur) - vue 开发必备 |
|
100 |
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - 脚本代码检查 |
|
101 |
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) - 代码格式化 |
|
102 |
- [Stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint) - css 格式化 |
351f60
|
103 |
|
陈 |
104 |
## 安装 |
|
105 |
|
|
106 |
```js |
afbcf0
|
107 |
// 使git对文件名大小写敏感 |
V |
108 |
git config core.ignorecase false |
351f60
|
109 |
|
陈 |
110 |
// 拉取项目代码 |
|
111 |
|
afbcf0
|
112 |
git clone https://github.com/anncwb/vue-vben-admin.git vue-vben-admin-2.0 |
351f60
|
113 |
|
afbcf0
|
114 |
cd vue-vben-admin-2.0 |
351f60
|
115 |
|
e8aede
|
116 |
// 如果使用别的包管理工具,可以自行安装 |
afbcf0
|
117 |
// 如果未安装yarn,请运行:npm install -g yarn |
351f60
|
118 |
yarn install |
陈 |
119 |
|
|
120 |
``` |
|
121 |
|
afbcf0
|
122 |
## 使用 |
351f60
|
123 |
|
afbcf0
|
124 |
### 开发环境 |
351f60
|
125 |
|
陈 |
126 |
```bash |
|
127 |
yarn serve |
|
128 |
``` |
|
129 |
|
|
130 |
### 打包 |
|
131 |
|
|
132 |
```bash |
|
133 |
|
afbcf0
|
134 |
yarn build # 打包 |
351f60
|
135 |
|
afbcf0
|
136 |
yarn build:no-cache # 打包,执行之前会先删除缓存 |
351f60
|
137 |
|
66b561
|
138 |
yarn report # 生成构建包报表预览 |
351f60
|
139 |
``` |
陈 |
140 |
|
|
141 |
### 格式化 |
|
142 |
|
|
143 |
```bash |
|
144 |
yarn lint:stylelint # 样式格式化 |
|
145 |
|
|
146 |
yarn lint:prettier # js/ts代码格式化 |
|
147 |
``` |
|
148 |
|
|
149 |
### 其他 |
|
150 |
|
|
151 |
```bash |
|
152 |
yarn reinstall # 删除依赖重新装,兼容window |
|
153 |
|
|
154 |
yarn preview # 本地进行打包预览 |
|
155 |
|
|
156 |
yarn log # 生成CHANGELOG |
afbcf0
|
157 |
|
V |
158 |
yarn clean:cache # 删除缓存 |
|
159 |
|
|
160 |
yarn clean:lib # 删除node_modules,兼容window系统 |
351f60
|
161 |
``` |
陈 |
162 |
|
|
163 |
## Git 提交规范 |
|
164 |
|
|
165 |
- 参考 [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) 规范 ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)) |
|
166 |
|
|
167 |
- `feat` 增加新功能 |
|
168 |
- `fix` 修复问题/BUG |
|
169 |
- `style` 代码风格相关无影响运行结果的 |
|
170 |
- `perf` 优化/性能提升 |
|
171 |
- `refactor` 重构 |
|
172 |
- `revert` 撤销修改 |
|
173 |
- `test` 测试相关 |
|
174 |
- `docs` 文档/注释 |
|
175 |
- `chore` 依赖更新/脚手架配置修改等 |
|
176 |
- `workflow` 工作流改进 |
|
177 |
- `ci` 持续集成 |
afbcf0
|
178 |
- `types` 类型定义文件更改 |
e8aede
|
179 |
- `wip` 开发中 |
351f60
|
180 |
|
陈 |
181 |
## 代码贡献 |
|
182 |
|
|
183 |
1. Fork 代码! |
|
184 |
2. 创建自己的分支: `git checkout -b feat/xxxx` |
|
185 |
3. 提交你的修改: `git commit -am 'feat(function): add xxxxx'` |
|
186 |
4. 推送您的分支: `git push origin feat/xxxx` |
|
187 |
5. 提交`pull request` |
|
188 |
|
afbcf0
|
189 |
## 已完成功能 |
351f60
|
190 |
|
陈 |
191 |
- [x] 项目搭建(基于 vite) |
|
192 |
- [x] 登录和注销 |
|
193 |
- [x] 菜单(可以搜索及拖拽以及菜单布局) |
|
194 |
- [x] 多标签页/面包屑 |
|
195 |
- [x] 基于角色的权限管理 |
|
196 |
- [x] 基于后台的权限管理 |
|
197 |
- [x] 分离的路由和菜单设置 |
|
198 |
- [x] 可折叠侧边栏 |
|
199 |
- [x] 可拖拽侧边栏 |
|
200 |
- [x] 多标签页模式/全局控制 |
|
201 |
- [x] 菜单搜索 |
|
202 |
- [x] 页面加载 loading |
|
203 |
- [x] 滚动条组件 |
|
204 |
- [x] 弹窗扩展(可拖拽,全屏,自适应高度) |
|
205 |
- [x] 模拟数据 |
|
206 |
- [x] hook 封装 |
|
207 |
- [x] 表单组件 |
|
208 |
- [x] 右键菜单 |
|
209 |
- [x] 水印插件 |
|
210 |
- [x] 动画组件 |
|
211 |
- [x] 二维码插件 |
|
212 |
- [x] 国际化插件 |
|
213 |
- [x] 详情组件 |
e9536b
|
214 |
- [x] 验证组件 |
351f60
|
215 |
- [x] 树组件 |
faf3f4
|
216 |
- [x] 图片预览组件 |
e4c952
|
217 |
- [x] 表格组件 |
21d0ed
|
218 |
- [x] 图表库 |
52ee35
|
219 |
- [x] 数字动画 |
4811cc
|
220 |
- [x] 首屏加载等待动画 |
bb3b8f
|
221 |
- [x] 抽取生产环境配置文件 |
afbcf0
|
222 |
|
V |
223 |
## 正在开发的功能 |
|
224 |
|
351f60
|
225 |
- [ ] 上传组件 |
52ee35
|
226 |
- [ ] 富文本组件 |
351f60
|
227 |
- [ ] 数据导入导出 |
21d0ed
|
228 |
- [ ] 全局错误处理 |
4811cc
|
229 |
- [ ] 主题配置 |
V |
230 |
- [ ] 黑暗主题 |
afbcf0
|
231 |
- [ ] 打包 Gzip |
bb3b8f
|
232 |
- [ ] 打包 CDN |
e8aede
|
233 |
- [ ] 系统性能优化 |
faf3f4
|
234 |
|
陈 |
235 |
更多组件/功能/建议/bug/欢迎提交 pr 或者 issue |
351f60
|
236 |
|
陈 |
237 |
## 加入我们 |
|
238 |
|
21d0ed
|
239 |
`Vue-Vben-Aadmin` 是完全开源免费的项目,在帮助开发者更方便地进行中大型管理系统开发,同时也提供 QQ 交流群(项目刚起步,人数较少,有兴趣的可以加群一起讨论),使用问题欢迎在群内提问。 |
351f60
|
240 |
|
陈 |
241 |
- QQ 群 `569291866` |
|
242 |
|
afbcf0
|
243 |
<img alt="VbenAdmin Logo" width="100" src="./.github/res/imgs/qq.jpeg"> |