Sanakey
2024-08-29 45b43f4ff4bea965638166ff619db1ef5afcad70
提交 | 用户 | age
ee5fb2 1 <div align="center"> <a href="https://github.com/anncwb/vue-vben-admin"> <img alt="VbenAdmin Logo" width="200" height="200" src="https://anncwb.github.io/anncwb/images/logo.png"> </a> <br> <br>
V 2
3 [![license](https://img.shields.io/github/license/anncwb/vue-vben-admin.svg)](LICENSE)
4
5 <h1>Vue vben admin</h1>
6 </div>
025ee9 7
V 8 **中文** | [English](./README.md)
9
ee5fb2 10 ## 简介
025ee9 11
32061f 12 Vue Vben Admin 是一个免费开源的中后台模版。使用了最新的`vue3`,`vite5`,`TypeScript`等主流技术开发,开箱即用的中后台前端解决方案,也可用于学习参考。
025ee9 13
ee5fb2 14 ## 特性
025ee9 15
32061f 16 - **最新技术栈**:使用 Vue3/vite5 等前端前沿技术开发
ee5fb2 17 - **TypeScript**: 应用程序级 JavaScript 的语言
V 18 - **主题**:可配置的主题
19 - **国际化**:内置完善的国际化方案
20 - **Mock 数据** 内置 Mock 数据方案
21 - **权限** 内置完善的动态路由权限生成方案
22 - **组件** 二次封装了多个常用的组件
025ee9 23
ee5fb2 24 ## 预览
025ee9 25
2387dc 26 - [vue-vben-admin](https://vben.vvbin.cn/) - 完整版中文站点
ee5fb2 27 - [vue-vben-admin-gh-pages](https://anncwb.github.io/vue-vben-admin/) - 完整版 github 站点
2387dc 28 - [vben-admin-thin-next](https://vben.vvbin.cn/thin/next/) - 简化版中文站点
ee5fb2 29 - [vben-admin-thin-gh-pages](https://anncwb.github.io/vben-admin-thin-next/) - 简化版 github 站点
025ee9 30
V 31 测试账号: vben/123456
32
33 <p align="center">
ee5fb2 34     <img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview1.png">
V 35     <img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview2.png">
36     <img alt="VbenAdmin Logo" width="100%" src="https://anncwb.github.io/anncwb/images/preview3.png">
025ee9 37 </p>
ee5fb2 38
V 39 ### 使用 Gitpod
40
41 在 Gitpod(适用于 GitHub 的免费在线开发环境)中打开项目,并立即开始编码.
42
43 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/anncwb/vue-vben-admin)
025ee9 44
V 45 ## 文档
46
7fad00 47 [文档地址](https://doc.vvbin.cn/)
025ee9 48
ee5fb2 49 ## 准备
025ee9 50
ee5fb2 51 - [node](http://nodejs.org/) 和 [git](https://git-scm.com/) -项目开发环境
V 52 - [Vite](https://vitejs.dev/) - 熟悉 vite 特性
53 - [Vue3](https://v3.vuejs.org/) - 熟悉 Vue 基础语法
54 - [TypeScript](https://www.typescriptlang.org/) - 熟悉`TypeScript`基本语法
55 - [Es6+](http://es6.ruanyifeng.com/) - 熟悉 es6 基本语法
56 - [Vue-Router-Next](https://next.router.vuejs.org/) - 熟悉 vue-router 基本使用
1262e1 57 - [Ant-Design-Vue](https://antdv.com/docs/vue/introduce-cn/) - ui 基本使用
ee5fb2 58 - [Mock.js](https://github.com/nuysoft/Mock) - mockjs 基本语法
025ee9 59
ee5fb2 60 ## 安装使用
025ee9 61
ee5fb2 62 - 获取项目代码
025ee9 63
ee5fb2 64 ```bash
223562 65 git clone https://github.com/vbenjs/vue-vben-admin.git
ee5fb2 66 ```
025ee9 67
ee5fb2 68 - 安装依赖
025ee9 69
ee5fb2 70 ```bash
V 71 cd vue-vben-admin
025ee9 72
999965 73 pnpm install
025ee9 74
V 75 ```
76
ee5fb2 77 - 运行
025ee9 78
V 79 ```bash
999965 80 pnpm serve
025ee9 81 ```
V 82
ee5fb2 83 - 打包
025ee9 84
V 85 ```bash
999965 86 pnpm build
025ee9 87 ```
V 88
c659c1 89 - docker
90
91 ### dockerFile 位于项目根目录下 并且支持差异化部署
92
93 #### 构建镜像
94
95 ```bash
96 docker build -t vue-vben-admin .
97 ```
98
99 #### 动态使用环境变量实现容器差异化部署,通过不同的 VG_BASE_URL 环境变量,指向不同的后端服务地址,下面例子使用 http://localhost:3333 作为后端服务地址,并且将容器映射到 6666 端口
100
101 ```bash
102 docker run --name vue-vben-admin -d -p 6666:80  -e VG_BASE_URL=http://localhost:3333 vue-vben-admin
103 ```
104
105 而后可以打开 http://localhost:6666 访问
106
ee5fb2 107 ## 更新日志
025ee9 108
ee5fb2 109 [CHANGELOG](./CHANGELOG.zh_CN.md)
025ee9 110
ee5fb2 111 ## 项目地址
025ee9 112
ee5fb2 113 - [vue-vben-admin](https://github.com/anncwb/vue-vben-admin) - 完整版
V 114 - [vue-vben-admin-thin-next](https://github.com/anncwb/vben-admin-thin-next) - 简化版
025ee9 115
ee5fb2 116 ## 如何贡献
025ee9 117
ee5fb2 118 非常欢迎你的加入![提一个 Issue](https://github.com/anncwb/vue-vben-admin/issues/new/choose) 或者提交一个 Pull Request。
025ee9 119
ee5fb2 120 **Pull Request:**
025ee9 121
ee5fb2 122 1. Fork 代码!
V 123 2. 创建自己的分支: `git checkout -b feat/xxxx`
124 3. 提交你的修改: `git commit -am 'feat(function): add xxxxx'`
125 4. 推送您的分支: `git push origin feat/xxxx`
126 5. 提交`pull request`
025ee9 127
ee5fb2 128 ## Git 贡献提交规范
025ee9 129
V 130 - 参考 [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))
131
132   - `feat` 增加新功能
133   - `fix` 修复问题/BUG
134   - `style` 代码风格相关无影响运行结果的
135   - `perf` 优化/性能提升
136   - `refactor` 重构
137   - `revert` 撤销修改
138   - `test` 测试相关
139   - `docs` 文档/注释
140   - `chore` 依赖更新/脚手架配置修改等
141   - `workflow` 工作流改进
142   - `ci` 持续集成
143   - `types` 类型定义文件更改
144   - `wip` 开发中
145
146 ## 浏览器支持
147
ee5fb2 148 本地开发推荐使用`Chrome 80+` 浏览器
025ee9 149
ee5fb2 150 支持现代浏览器, 不支持 IE
025ee9 151
V 152 | [<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 |
153 | :-: | :-: | :-: | :-: | :-: |
154 | not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
155
c2635f 156 ## 相关仓库
V 157
158 如果这些插件对你有帮助,可以给一个 star 支持下
159
160 - [vite-plugin-mock](https://github.com/anncwb/vite-plugin-mock) - 用于本地及开发环境数据 mock
161 - [vite-plugin-html](https://github.com/anncwb/vite-plugin-html) - 用于 html 模版转换及压缩
162 - [vite-plugin-compression](https://github.com/anncwb/vite-plugin-compression) - 用于打包输出.gz|.brotil 文件
163 - [vite-plugin-svg-icons](https://github.com/anncwb/vite-plugin-svg-icons) - 用于快速生成 svg 雪碧图
164
165 ## 后台整合示例
166
167 - [lamp-cloud](https://github.com/zuihou/lamp-cloud) - 基于 SpringCloud Alibaba 的微服务中后台快速开发平台
56a966 168 - [matecloud](https://github.com/matevip/matecloud) - MateCloud 微服务脚手架,基于 Spring Cloud 2020.0.3、SpringBoot 2.5.3 的全开源平台
c2635f 169
ee5fb2 170 ## 维护者
025ee9 171
3689bd 172 [@Vben](https://github.com/anncwb) [@Jinmao](https://github.com/jinmao88)
025ee9 173
18211f 174 ## 感谢
3689bd 175
18211f 176 <img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" alt="JetBrains Logo (Main) logo." height='120'>
ee5fb2 177
V 178 ## 交流
179
180 `Vue-vben-Admin` 是完全开源免费的项目,在帮助开发者更方便地进行中大型管理系统开发,同时也提供 QQ 交流群使用问题欢迎在群内提问。
025ee9 181
V 182 - QQ 群 `569291866`
183
3689bd 184 ## Star 历史
IW 185
186 [![Star History Chart](https://api.star-history.com/svg?repos=vbenjs/vue-vben-admin&type=Date)](https://star-history.com/#vbenjs/vue-vben-admin&Date)
187
ee5fb2 188 ## License
V 189
190 [MIT © Vben-2020](./LICENSE)