158 lines
5.9 KiB
Markdown
158 lines
5.9 KiB
Markdown
<div align="center">
|
||
<a href="https://github.com/anncwb/vue-vben-admin">
|
||
<img alt="VbenAdmin Logo" width="215" src="https://unpkg.com/@vbenjs/static-source@0.1.7/source/logo-v1.webp">
|
||
</a>
|
||
<br>
|
||
<br>
|
||
|
||
[](LICENSE)
|
||
|
||
<h1>Vue Vben Admin</h1>
|
||
</div>
|
||
|
||
[](https://sonarcloud.io/summary/new_code?id=vbenjs_vue-vben-admin)    
|
||
|
||
**中文** | [English](./README.md) | [日本語](./README.ja-JP.md)
|
||
|
||
## 简介
|
||
|
||
Vue Vben Admin 是 Vue Vben Admin 的升级版本。作为一个免费开源的中后台模板，它采用了最新的 Vue 3、Vite、TypeScript 等主流技术开发，开箱即用，可用于中后台前端开发，也适合学习参考。
|
||
|
||
## 升级提示
|
||
|
||
该版本为最新版本 `5.0`，与其他版本不兼容，如果你是新项目，建议使用最新版本。如果你想查看旧版本，请使用 [v2 分支](https://github.com/vbenjs/vue-vben-admin/tree/v2)
|
||
|
||
## 特性
|
||
|
||
- **最新技术栈**：使用 Vue3/vite 等前端前沿技术开发
|
||
- **TypeScript**：应用程序级 JavaScript 的语言
|
||
- **主题**：提供多套主题色彩，可配置自定义主题
|
||
- **国际化**：内置完善的国际化方案
|
||
- **权限**：内置完善的动态路由权限生成方案
|
||
|
||
## 预览
|
||
|
||
- [Vben Admin](https://vben.pro/) - 完整版中文站点
|
||
|
||
测试账号：vben/123456
|
||
|
||
<div align="center">
|
||
<img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview1.png">
|
||
<img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview2.png">
|
||
<img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview3.png">
|
||
</div>
|
||
|
||
### 使用 Gitpod
|
||
|
||
在 Gitpod（适用于 GitHub 的免费在线开发环境）中打开项目，并立即开始编码。
|
||
|
||
[](https://gitpod.io/#https://github.com/vbenjs/vue-vben-admin)
|
||
|
||
## 文档
|
||
|
||
[文档地址](https://doc.vben.pro/)
|
||
|
||
## 安装使用
|
||
|
||
1. 获取项目代码
|
||
|
||
```bash
|
||
git clone https://github.com/vbenjs/vue-vben-admin.git
|
||
```
|
||
|
||
2. 安装依赖
|
||
|
||
```bash
|
||
cd vue-vben-admin
|
||
npm i -g corepack
|
||
pnpm install
|
||
```
|
||
|
||
3. 运行
|
||
|
||
```bash
|
||
pnpm dev
|
||
```
|
||
|
||
4. 打包
|
||
|
||
```bash
|
||
pnpm build
|
||
```
|
||
|
||
## 更新日志
|
||
|
||
[CHANGELOG](https://github.com/vbenjs/vue-vben-admin/releases)
|
||
|
||
## 如何贡献
|
||
|
||
非常欢迎你的加入！[提一个 Issue](https://github.com/anncwb/vue-vben-admin/issues/new/choose) 或者提交一个 Pull Request。
|
||
|
||
**Pull Request 流程：**
|
||
|
||
1. Fork 代码
|
||
2. 创建自己的分支：`git checkout -b feature/xxxx`
|
||
3. 提交你的修改：`git commit -am 'feat(function): add xxxxx'`
|
||
4. 推送您的分支：`git push origin feature/xxxx`
|
||
5. 提交 `pull request`
|
||
|
||
## Git 贡献提交规范
|
||
|
||
参考 [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))
|
||
|
||
- `feat` 增加新功能
|
||
- `fix` 修复问题/BUG
|
||
- `style` 代码风格相关无影响运行结果的
|
||
- `perf` 优化/性能提升
|
||
- `refactor` 重构
|
||
- `revert` 撤销修改
|
||
- `test` 测试相关
|
||
- `docs` 文档/注释
|
||
- `chore` 依赖更新/脚手架配置修改等
|
||
- `ci` 持续集成
|
||
- `types` 类型定义文件更改
|
||
|
||
## 浏览器支持
|
||
|
||
本地开发推荐使用 `Chrome 80+` 浏览器
|
||
|
||
支持现代浏览器，不支持 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 |
|
||
| :-: | :-: | :-: | :-: |
|
||
| last 2 versions | last 2 versions | last 2 versions | last 2 versions |
|
||
|
||
## 维护者
|
||
|
||
[@Vben](https://github.com/anncwb)
|
||
|
||
## Star 历史
|
||
|
||
[](https://star-history.com/#vbenjs/vue-vben-admin&Date)
|
||
|
||
## 捐赠
|
||
|
||
如果你觉得这个项目对你有帮助，你可以帮作者买一杯咖啡表示支持！
|
||
|
||
|
||
|
||
<a style="display: block;width: 100px;height: 50px;line-height: 50px; color: #fff;text-align: center; background: #408aed;border-radius: 4px;" href="https://www.paypal.com/paypalme/cvvben">Paypal Me</a>
|
||
|
||
## 贡献者
|
||
|
||
<a href="https://openomy.app/github/vbenjs/vue-vben-admin" target="_blank" style="display: block; width: 100%;" align="center">
|
||
<img src="https://openomy.app/svg?repo=vbenjs/vue-vben-admin&chart=bubble&latestMonth=3" target="_blank" alt="Contribution Leaderboard" style="display: block; width: 100%;" />
|
||
</a>
|
||
|
||
<a href="https://github.com/vbenjs/vue-vben-admin/graphs/contributors">
|
||
<img alt="Contributors" src="https://contrib.rocks/image?repo=vbenjs/vue-vben-admin" />
|
||
</a>
|
||
|
||
## Discord
|
||
|
||
- [Github Discussions](https://github.com/anncwb/vue-vben-admin/discussions)
|
||
|
||
## 许可证
|
||
|
||
[MIT © Vben-2020](./LICENSE)
|