Commit 351f60a8af190dc5a3185eafc8ee8f5140b55000
1 parent
2f6253cf
chore: add Readme.md
Showing
6 changed files
with
229 additions
and
0 deletions
README.md
0 → 100644
| 1 | +<p align="center"> | ||
| 2 | + <a href="https://github.com/anncwb/vue-vben-admin" target="_blank"> | ||
| 3 | + <img alt="VbenAdmin Logo" width="200" src="./docs/imgs/logo.png"> | ||
| 4 | + </a> | ||
| 5 | +</p> | ||
| 6 | +<h2 align="center">VUE VBEN ADMIN</h2> | ||
| 7 | + | ||
| 8 | +**中文** | ||
| 9 | + | ||
| 10 | +该分支为2.0新分支，使用vue3进行开发。 | ||
| 11 | + | ||
| 12 | +1.0分支请切换到`master`分支。1.0采用`vue2.6`+`vue-composition-api`+`vue-cli`开发 | ||
| 13 | + | ||
| 14 | +一个适合开发中大型项目的基础框架，需要对`vue`,`typescript`有一定的了解,也可以作为了解新写法的一个例子来看，提前适应后续新版本的开发方式 | ||
| 15 | + | ||
| 16 | +项目基于`ant-design-vue`,`typescript`,`vue3.0`,`vite`,`tailwindcss`,`tsx`实现的 vue3 风格的后台管理系统， | ||
| 17 | + | ||
| 18 | + | ||
| 19 | +### gitHub 地址 | ||
| 20 | + | ||
| 21 | +[vue-vben-admin2.0](https://github.com/anncwb/vue-vben-admin) | ||
| 22 | + | ||
| 23 | + | ||
| 24 | +<p align="center"> | ||
| 25 | + <img alt="VbenAdmin Logo" width="100%" src="./build/docs/imgs/preview1.png"> | ||
| 26 | + <img alt="VbenAdmin Logo" width="100%" src="./build/docs/imgs/preview2.png"> | ||
| 27 | + <img alt="VbenAdmin Logo" width="100%" src="./build/docs/imgs/preview3.png"> | ||
| 28 | +</p> | ||
| 29 | + | ||
| 30 | +### 文档 | ||
| 31 | + | ||
| 32 | +2.0文档还没开始写。后续补上。。 | ||
| 33 | + | ||
| 34 | + | ||
| 35 | + | ||
| 36 | + | ||
| 37 | + | ||
| 38 | +## 使用到的技术 | ||
| 39 | + | ||
| 40 | +- vue3 | ||
| 41 | +- composition-api: | ||
| 42 | +- vuex4 | ||
| 43 | +- vuex-module-decorators | ||
| 44 | +- vue-router4 | ||
| 45 | +- axios@0.19.2 | ||
| 46 | +- ant-design-vue@2.x | ||
| 47 | +- mockjs | ||
| 48 | +- vue-i18n | ||
| 49 | +- moment | ||
| 50 | +- lodash | ||
| 51 | + | ||
| 52 | +[更新日志](CHANGELOG.md) | ||
| 53 | + | ||
| 54 | +- [使用到的技术](#使用到的技术) | ||
| 55 | +- [环境要求](#环境要求) | ||
| 56 | + - [建议开发环境](#建议开发环境) | ||
| 57 | +- [安装](#安装) | ||
| 58 | +- [命令参考(Terminal)](#命令参考terminal) | ||
| 59 | + - [启动开发环境](#启动开发环境) | ||
| 60 | + - [打包](#打包) | ||
| 61 | + - [格式化](#格式化) | ||
| 62 | + - [其他](#其他) | ||
| 63 | +- [Git 提交规范](#git-提交规范) | ||
| 64 | +- [代码贡献](#代码贡献) | ||
| 65 | +- [开发计划](#开发计划) | ||
| 66 | +- [加入我们](#加入我们) | ||
| 67 | +- | ||
| 68 | + | ||
| 69 | +## 环境要求 | ||
| 70 | + | ||
| 71 | +- `Node.js`: >= v10 | ||
| 72 | +- `yarn`: 最新 | ||
| 73 | + | ||
| 74 | +### 建议开发环境 | ||
| 75 | + | ||
| 76 | +- `Git`: 最新 代码管理 | ||
| 77 | +- `Visual Studio Code` (VSCode): 最新 IDE | ||
| 78 | + | ||
| 79 | +VSCode 插件 | ||
| 80 | + | ||
| 81 | +- `Vetur`: vue 开发必备 | ||
| 82 | +- `GitLens`: Git 可视化工具 | ||
| 83 | +- `ESLint`: 脚本代码检查 | ||
| 84 | +- `stylelint`: 样式代码检查 | ||
| 85 | +- `Prettier - Code formatter`:代码格式化 | ||
| 86 | + | ||
| 87 | + | ||
| 88 | +## 安装 | ||
| 89 | + | ||
| 90 | +```js | ||
| 91 | +git config core.ignorecase false # 使git对文件名大小写敏感 | ||
| 92 | + | ||
| 93 | +// 拉取项目代码 | ||
| 94 | + | ||
| 95 | +git clone https://github.com/anncwb/vue-vben-admin.git | ||
| 96 | + | ||
| 97 | +cd vue-vben-admin | ||
| 98 | + | ||
| 99 | +// 最好使用yarn，否则热更新可能出现问题 | ||
| 100 | +yarn install | ||
| 101 | + | ||
| 102 | +``` | ||
| 103 | + | ||
| 104 | +## 命令参考(Terminal) | ||
| 105 | + | ||
| 106 | +### 启动开发环境 | ||
| 107 | + | ||
| 108 | +```bash | ||
| 109 | +yarn serve | ||
| 110 | +``` | ||
| 111 | + | ||
| 112 | +### 打包 | ||
| 113 | + | ||
| 114 | +同时会生成文件名 `window-glob.js` 配置文件，项目配置可以动态修改该文件实时更新代码变量，比如接口地址 | ||
| 115 | + | ||
| 116 | +```bash | ||
| 117 | + | ||
| 118 | +yarn build # 打包 会使用hardSource进行打包 | ||
| 119 | + | ||
| 120 | +yarn build:no-cache # 打包 不会使用hardSource进行打包 | ||
| 121 | + | ||
| 122 | +yarn report # 生成构建包表表预览 | ||
| 123 | +``` | ||
| 124 | + | ||
| 125 | + | ||
| 126 | +### 格式化 | ||
| 127 | + | ||
| 128 | +```bash | ||
| 129 | +yarn lint:stylelint # 样式格式化 | ||
| 130 | + | ||
| 131 | +yarn lint:prettier # js/ts代码格式化 | ||
| 132 | +``` | ||
| 133 | + | ||
| 134 | +### 其他 | ||
| 135 | + | ||
| 136 | +```bash | ||
| 137 | +yarn reinstall # 删除依赖重新装，兼容window | ||
| 138 | + | ||
| 139 | +yarn preview # 本地进行打包预览 | ||
| 140 | + | ||
| 141 | +yarn log # 生成CHANGELOG | ||
| 142 | +``` | ||
| 143 | + | ||
| 144 | +## Git 提交规范 | ||
| 145 | + | ||
| 146 | +- 参考 [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)) | ||
| 147 | + | ||
| 148 | + - `feat` 增加新功能 | ||
| 149 | + - `fix` 修复问题/BUG | ||
| 150 | + - `style` 代码风格相关无影响运行结果的 | ||
| 151 | + - `perf` 优化/性能提升 | ||
| 152 | + - `refactor` 重构 | ||
| 153 | + - `revert` 撤销修改 | ||
| 154 | + - `test` 测试相关 | ||
| 155 | + - `docs` 文档/注释 | ||
| 156 | + - `chore` 依赖更新/脚手架配置修改等 | ||
| 157 | + - `workflow` 工作流改进 | ||
| 158 | + - `ci` 持续集成 | ||
| 159 | + - `mod` 不确定分类的修改 | ||
| 160 | + - `wip` 删除文件 | ||
| 161 | + | ||
| 162 | + | ||
| 163 | +## 代码贡献 | ||
| 164 | + | ||
| 165 | +1. Fork 代码! | ||
| 166 | +2. 创建自己的分支: `git checkout -b feat/xxxx` | ||
| 167 | +3. 提交你的修改: `git commit -am 'feat(function): add xxxxx'` | ||
| 168 | +4. 推送您的分支: `git push origin feat/xxxx` | ||
| 169 | +5. 提交`pull request` | ||
| 170 | + | ||
| 171 | +## 开发计划 | ||
| 172 | + | ||
| 173 | +由于开发时间较短，所以功能暂时较少 | ||
| 174 | + | ||
| 175 | +后续会逐步完善，有需要什么组件可以提出来 | ||
| 176 | + | ||
| 177 | +- [x] 项目搭建（基于 vite） | ||
| 178 | +- [x] 登录和注销 | ||
| 179 | +- [x] 菜单（可以搜索及拖拽以及菜单布局） | ||
| 180 | +- [x] 多标签页/面包屑 | ||
| 181 | +- [x] 基于角色的权限管理 | ||
| 182 | +- [x] 基于后台的权限管理 | ||
| 183 | +- [x] 分离的路由和菜单设置 | ||
| 184 | +- [x] 可折叠侧边栏 | ||
| 185 | +- [x] 可拖拽侧边栏 | ||
| 186 | +- [x] 多标签页模式/全局控制 | ||
| 187 | +- [x] 菜单搜索 | ||
| 188 | +- [x] 页面加载 loading | ||
| 189 | +- [x] 滚动条组件 | ||
| 190 | +- [x] 弹窗扩展（可拖拽,全屏,自适应高度） | ||
| 191 | +- [x] 全屏 | ||
| 192 | +- [x] 模拟数据 | ||
| 193 | +- [x] 剪贴板封装 | ||
| 194 | +- [x] hook 封装 | ||
| 195 | +- [x] 项目可配置 | ||
| 196 | +- [x] 表单组件 | ||
| 197 | +- [x] 右键菜单 | ||
| 198 | +- [x] 水印插件 | ||
| 199 | +- [x] 动画组件 | ||
| 200 | +- [x] 二维码插件 | ||
| 201 | +- [x] 国际化插件 | ||
| 202 | +- [x] 详情组件 | ||
| 203 | +- [x] 图片裁剪 | ||
| 204 | +- [x] 验证码/验证组件 | ||
| 205 | +- [x] 树组件 | ||
| 206 | +- [x] 系统性能优化 | ||
| 207 | +- [x] 兼容最新`vuex`,`vue-router` | ||
| 208 | +- [] 图片预览组件 | ||
| 209 | +- [ ] 图表库 | ||
| 210 | +- [ ] 数字动画 | ||
| 211 | +- [ ] 主题配置 | ||
| 212 | +- [ ] 表格组件 | ||
| 213 | +- [ ] 富文本组件 | ||
| 214 | +- [ ] 首屏加载等待动画 | ||
| 215 | +- [ ] 上传组件 | ||
| 216 | +- [ ] 可编辑表格 | ||
| 217 | +- [ ] 数据导入导出 | ||
| 218 | +- [ ] 搭建`vite`版本 | ||
| 219 | +- [ ] 懒加载组件 | ||
| 220 | +- [ ] 黑暗主题 | ||
| 221 | +- [ ] 更多组件/功能/建议/bug/欢迎提交 pr 或者 issue | ||
| 222 | + | ||
| 223 | +## 加入我们 | ||
| 224 | + | ||
| 225 | +`VUE-VBEN-ADMIN` 是完全开源免费的项目，旨在帮助开发者更方便地进行中大型管理系统开发，同时也提供 QQ 交流群(项目刚起步，人数较少，有兴趣的可以加群一起讨论)，使用问题欢迎在群内提问。 | ||
| 226 | + | ||
| 227 | +- QQ 群 `569291866` | ||
| 228 | + | ||
| 229 | + <img alt="VbenAdmin Logo" width="100" src="./build/docs/imgs/qq.jpeg"> |
build/docs/imgs/logo.png
0 → 100644
1.94 KB
build/docs/imgs/preview1.png
0 → 100644
389 KB
build/docs/imgs/preview2.png
0 → 100644
548 KB
build/docs/imgs/preview3.png
0 → 100644
512 KB
build/docs/imgs/qq.jpeg
0 → 100644
102 KB