VbenAdmin Logo

[![license](https://img.shields.io/github/license/anncwb/vue-vben-admin.svg)](LICENSE)

Vue vben admin

**中文** | [English](./README.md) ## 简介 Vue Vben Admin 是一个免费开源的中后台模版。使用了最新的`vue3`,`vite4`,`TypeScript`等主流技术开发,开箱即用的中后台前端解决方案,也可用于学习参考。 ## 特性 - **最新技术栈**:使用 Vue3/vite2 等前端前沿技术开发 - **TypeScript**: 应用程序级 JavaScript 的语言 - **主题**:可配置的主题 - **国际化**:内置完善的国际化方案 - **Mock 数据** 内置 Mock 数据方案 - **权限** 内置完善的动态路由权限生成方案 - **组件** 二次封装了多个常用的组件 ## 预览 - [vue-vben-admin](https://vben.vvbin.cn/) - 完整版中文站点 - [vue-vben-admin-gh-pages](https://anncwb.github.io/vue-vben-admin/) - 完整版 github 站点 - [vben-admin-thin-next](https://vben.vvbin.cn/thin/next/) - 简化版中文站点 - [vben-admin-thin-gh-pages](https://anncwb.github.io/vben-admin-thin-next/) - 简化版 github 站点 测试账号: vben/123456

VbenAdmin Logo VbenAdmin Logo VbenAdmin Logo

### 使用 Gitpod 在 Gitpod(适用于 GitHub 的免费在线开发环境)中打开项目,并立即开始编码. [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/anncwb/vue-vben-admin) ## 文档 [文档地址](https://doc.vvbin.cn/) ## 准备 - [node](http://nodejs.org/) 和 [git](https://git-scm.com/) -项目开发环境 - [Vite](https://vitejs.dev/) - 熟悉 vite 特性 - [Vue3](https://v3.vuejs.org/) - 熟悉 Vue 基础语法 - [TypeScript](https://www.typescriptlang.org/) - 熟悉`TypeScript`基本语法 - [Es6+](http://es6.ruanyifeng.com/) - 熟悉 es6 基本语法 - [Vue-Router-Next](https://next.router.vuejs.org/) - 熟悉 vue-router 基本使用 - [Ant-Design-Vue](https://antdv.com/docs/vue/introduce-cn/) - ui 基本使用 - [Mock.js](https://github.com/nuysoft/Mock) - mockjs 基本语法 ## 安装使用 - 获取项目代码 ```bash git clone https://github.com/anncwb/vue-vben-admin.git ``` - 安装依赖 ```bash cd vue-vben-admin pnpm install ``` - 运行 ```bash pnpm serve ``` - 打包 ```bash pnpm build ``` - docker ### dockerFile 位于项目根目录下 并且支持差异化部署 #### 构建镜像 ```bash docker build -t vue-vben-admin . ``` #### 动态使用环境变量实现容器差异化部署,通过不同的 VG_BASE_URL 环境变量,指向不同的后端服务地址,下面例子使用 http://localhost:3333 作为后端服务地址,并且将容器映射到 6666 端口 ```bash docker run --name vue-vben-admin -d -p 6666:80 -e VG_BASE_URL=http://localhost:3333 vue-vben-admin ``` 而后可以打开 http://localhost:6666 访问 ## 更新日志 [CHANGELOG](./CHANGELOG.zh_CN.md) ## 项目地址 - [vue-vben-admin](https://github.com/anncwb/vue-vben-admin) - 完整版 - [vue-vben-admin-thin-next](https://github.com/anncwb/vben-admin-thin-next) - 简化版 ## 如何贡献 非常欢迎你的加入![提一个 Issue](https://github.com/anncwb/vue-vben-admin/issues/new/choose) 或者提交一个 Pull Request。 **Pull Request:** 1. Fork 代码! 2. 创建自己的分支: `git checkout -b feat/xxxx` 3. 提交你的修改: `git commit -am 'feat(function): add xxxxx'` 4. 推送您的分支: `git push origin feat/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` 依赖更新/脚手架配置修改等 - `workflow` 工作流改进 - `ci` 持续集成 - `types` 类型定义文件更改 - `wip` 开发中 ## 浏览器支持 本地开发推荐使用`Chrome 80+` 浏览器 支持现代浏览器, 不支持 IE | [ Edge](http://godban.github.io/browsers-support-badges/)
IE | [ Edge](http://godban.github.io/browsers-support-badges/)
Edge | [Firefox](http://godban.github.io/browsers-support-badges/)
Firefox | [Chrome](http://godban.github.io/browsers-support-badges/)
Chrome | [Safari](http://godban.github.io/browsers-support-badges/)
Safari | | :-: | :-: | :-: | :-: | :-: | | not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions | ## 相关仓库 如果这些插件对你有帮助,可以给一个 star 支持下 - [vite-plugin-mock](https://github.com/anncwb/vite-plugin-mock) - 用于本地及开发环境数据 mock - [vite-plugin-html](https://github.com/anncwb/vite-plugin-html) - 用于 html 模版转换及压缩 - [vite-plugin-compression](https://github.com/anncwb/vite-plugin-compression) - 用于打包输出.gz|.brotil 文件 - [vite-plugin-svg-icons](https://github.com/anncwb/vite-plugin-svg-icons) - 用于快速生成 svg 雪碧图 ## 后台整合示例 - [lamp-cloud](https://github.com/zuihou/lamp-cloud) - 基于 SpringCloud Alibaba 的微服务中后台快速开发平台 - [matecloud](https://github.com/matevip/matecloud) - MateCloud 微服务脚手架,基于 Spring Cloud 2020.0.3、SpringBoot 2.5.3 的全开源平台 ## 维护者 [@Vben](https://github.com/anncwb) [@Jinmao](https://github.com/jinmao88) ## 感谢 JetBrains Logo (Main) logo. ## 交流 `Vue-vben-Admin` 是完全开源免费的项目,在帮助开发者更方便地进行中大型管理系统开发,同时也提供 QQ 交流群使用问题欢迎在群内提问。 - QQ 群 `569291866` ## Star 历史 [![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) ## License [MIT © Vben-2020](./LICENSE)