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