From 6c573366178f0f1d2b3034226e1804885a93b304 Mon Sep 17 00:00:00 2001 From: huzhushan Date: Wed, 14 Apr 2021 15:28:26 +0800 Subject: [PATCH] update --- README.md | 118 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 118 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..2680733 --- /dev/null +++ b/README.md @@ -0,0 +1,118 @@ +
VEA Logo

+ +[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](LICENSE) + +

Vue3 Element Admin

+
+ +**中文** | [English](./README.md) + +## 简介 + +**Vue3 Element Admin** 是一个免费开源的中后台模版。基于`vue3`+`ElementPlus`+`Vite`开发，是一个开箱即用的中后台前端解决方案，它可以帮助你快速搭建企业级中后台产品原型，也可用于学习参考。 + +- [在线预览](https://huzhushan.gitee.io/vue3-element-admin-site/) +- [使用文档](https://huzhushan.gitee.io/vue3-element-admin) + +## 视频教程 + +- [使用 vue3-element-admin 开发后台管理系统]() +- [vue3-element-admin 架构搭建过程]() + +## 技术储备 + +> 提前了解和学习以下知识会对您使用本项目有很大的帮助 + +- [node](http://nodejs.org/) 和 [git](https://git-scm.com/) -项目开发环境 +- [Es6+](http://es6.ruanyifeng.com/) - 熟悉 es6 基本语法 +- [Vite](https://www.pipipi.net/vite/) - 熟悉 vite 特性 +- [Vue3](https://v3.vuejs.org/) - 熟悉 Vue 基础语法 +- [Vue-Router-Next](https://next.router.vuejs.org/zh/) - 熟悉 vue-router@4 基本使用 +- [Element-Plus](https://element-plus.gitee.io/#/zh-CN) - ui 基本使用 +- [Mock.js](https://github.com/nuysoft/Mock) - mockjs 基本语法 + +## 安装使用 + +```bash +# 克隆项目 +git clone https://github.com/huzhushan/vue3-element-admin.git + +# 进入项目目录 +cd vue3-element-admin + +# 安装依赖 +npm install + +# 建议不要直接使用 cnpm 安装依赖，会有各种诡异的 bug。可以通过如下操作解决 npm 下载速度慢的问题 +npm install --registry=https://registry.npm.taobao.org + +# 启动服务 +npm start +``` + +## 打包发布 + +```bash +npm run build +``` + +## 更新日志 + +[CHANGELOG](https://github.com/huzhushan/vue3-element-admin/releases) + +## 如何贡献 + +非常欢迎你的加入！[提一个 Issue](https://github.com/huzhushan/vue3-element-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+` 浏览器 + +| [ 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 | + +## 维护者 + +[@huzhushan](https://github.com/huzhushan) + +## 捐赠 + +如果你觉得这个项目对你有帮助，你可以帮作者买一杯果汁表示支持:tropical_drink: +![donate](https://huzhushan.gitee.io/donate/donation.png) + +## 交流 + +`Vue3-Element-Admin` 是完全开源免费的项目，在帮助开发者更方便地进行中大型管理系统开发，同时也提供 QQ 交流群使用问题欢迎在群内提问。 + +- QQ 群 `734037120` + +## License + +[MIT © ZSEN-2020](./LICENSE)