README.zh-CN.md

v2.0.0

预览地址

预览地址 文档地址

实际开发项目

ruoyi-vue-vben

简介

• Vue Vben Admin 是一个免费开源的中后台模版。
• 本项目基于 vben2.10 版本，升级最新版vue、vite、antdv4等依赖，重构部分组件，重构代码样式，重构 setup 语法糖。
• 使用了最新的Vue3,Vite4,Antdv4,TypeScript5,Pinia等主流技术开发，开箱即用的中后台前端解决方案。

框架

框架	说明	版本
Vue	Vue 框架	3.3.4
Vite	开发与构建工具	4.4.4
ant-design-vue	ant-design-vue	4.0.0
TypeScript	JavaScript 的超集	5.1.6
pinia	Vue 存储库 替代 vuex5	2.1.4
vueuse	常用工具集	10.2.1
vue-i18n	国际化	9.2.2
vue-router	Vue 路由	4.2.4
unocss	原子 css	0.53.5
iconify	在线图标库	3.1.1

特性

• 最新技术栈：使用 Vue3/vite4/antdv4 等前端前沿技术开发
• TypeScript: 应用程序级 JavaScript 的语言
• 主题：可配置的主题
• 国际化：内置完善的国际化方案
• Mock 数据 内置 Mock 数据方案
• 权限 内置完善的动态路由权限生成方案
• 组件 二次封装了多个常用的组件

准备

• node 和 git -项目开发环境
• Vite4 - 熟悉 vite 特性
• Vue3 - 熟悉 Vue 基础语法
• TypeScript - 熟悉TypeScript基本语法
• Es6+ - 熟悉 es6 基本语法
• Vue-Router-Next - 熟悉 vue-router 基本使用
• Ant-Design-Vue - ui 基本使用
• Mock.js - mockjs 基本语法

安装使用

• 获取项目代码

git clone https://github.com/xingyu4j/vue-vben-admin.git
or
git clone https://gitee.com/xingyu4j/vue-vben-admin.git

• 安装依赖

cd vue-vben-admin

pnpm i

• 运行

pnpm dev

• 打包

pnpm build

• docker

dockerFile 位于项目根目录下 并且支持差异化部署

构建镜像

docker build -t vue-vben-admin .

动态使用环境变量实现容器差异化部署,通过不同的 VG_BASE_URL 环境变量，指向不同的后端服务地址，下面例子使用 http://localhost:3333 作为后端服务地址，并且将容器映射到 6666 端口

docker run --name vue-vben-admin -d -p 6666:80  -e VG_BASE_URL=http://localhost:3333 vue-vben-admin

而后可以打开 http://localhost:6666 访问

Git 贡献提交规范

• 参考 vue 规范 (Angular)

  • feat 增加新功能
  • fix 修复问题/BUG
  • style 代码风格相关无影响运行结果的
  • perf 优化/性能提升
  • refactor 重构
  • revert 撤销修改
  • test 测试相关
  • docs 文档/注释
  • chore 依赖更新/脚手架配置修改等
  • workflow 工作流改进
  • ci 持续集成
  • types 类型定义文件更改
  • wip 开发中

浏览器支持

本地开发推荐使用Chrome 80+ 浏览器

支持现代浏览器, 不支持 IE

IE	Edge	Firefox	Chrome	Safari
not support	last 2 versions	last 2 versions	last 2 versions	last 2 versions