diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..8eff93d07d844679d46d1b09d454e6027dcb43f5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 zhanglp + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.en.md b/README.en.md index 5eae3c4639b63ca91e01c01c22c1906ba816f7fa..678681401f2c0cace695bac9aad5c4265d402c7d 100644 --- a/README.en.md +++ b/README.en.md @@ -1,36 +1,95 @@ -# quick-vue3-admin +
quick-vue3-admin Logoquick-vue3-admin Logo

+
-#### Description -quick-vue3-admin是一套快速搭建后台系统框架，基于vite2+element-plus进行二次封装，使用最新技术栈vue3 +**中文** | [English](./README.en.md) -#### Software Architecture -Software architecture description +## 简介 -#### Installation +quick-vue3-admin 是一款免费开源快速搭建中后台系统框架。本框架基于 vite2+element-plus 等最新主流技术并封装了通用的组件方便开发者提高工作效率。后期也会通过版本升级的方式来维护并更新，使开发者拥有一款长期并且稳定的脚手架。 -1. xxxx -2. xxxx -3. xxxx +## 软件特色 -#### Instructions +1. 使用前端最新技术栈 vite2、vue3 和 typescript +2. 封装了通用的组件 +3. 提供了系统管理常用功能模块 +4. 提供权限管理模块 +5. 动态菜单技术 +6. 动态路由技术 +7. 前后端分离 +8. 官方提供稳定并长期维护的后端接口项目 -1. xxxx -2. xxxx -3. xxxx +## 预览 -#### Contribution +- [quick-vue3-admin](https://ainiteam.com:3101/) - 框架演示 -1. Fork the repository -2. Create Feat_xxx branch -3. Commit your code -4. Create Pull Request +演示账号密码：admin/123456 +## 文档 -#### Gitee Feature +文档地址完善中 -1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md -2. Gitee blog [blog.gitee.com](https://blog.gitee.com) -3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) -4. The most valuable open source project [GVP](https://gitee.com/gvp) -5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) -6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +## 安装使用 + +- 克隆项目 + +```bash +git clone https://gitee.com/zhanglp520/quick-vue3-admin.git +``` + +- 安装 pnpm + +```bash +npm install -g pnpm +``` + +- 安装项目依赖包 + +```bash +pnpm install +``` + +- 运行 + +```bash +pnpm run dev +``` + +运行命令执行服务启动后，浏览器输入：http://localhost:3001/ + +- eslint 检测 + +```bash +pnpm run lint 仅检测 + +pnpm run lint-fix 检测并尝试修复 +``` + +- 打包上线 + +```bash +pnpm run build +``` + +## 后端接口 + +官方提供后端接口项目：https://gitee.com/zhanglp520/quick-node-express.git + +## 寻求帮助 + +1. 百度尝试解决 +2. 发起 Issue +3. 加 quick 框架 QQ 群：558795174 + +## License + +[MIT © quick-vue3-admin](./LICENSE) + +## 参与贡献 + +1. Fork 本仓库 +2. 新建 Feat_xxx 分支 +3. 提交代码 +4. 新建 Pull Request +5. 点个 star 把 +6. 如果你觉得这个项目对你有帮助，你可以帮作者买一杯咖啡表示支持! + ![donate](./public/payImages/alipay.jpg) diff --git a/README.md b/README.md index db10ded709a49ac93b0848aedeb9b7f7eb2217f3..678681401f2c0cace695bac9aad5c4265d402c7d 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,95 @@ -# quick-vue3-admin +
quick-vue3-admin Logoquick-vue3-admin Logo

+
-#### 介绍 +**中文** | [English](./README.en.md) -quick-vue3-admin 是一套快速搭建后台系统框架，基于 vite2+element-plus 进行二次封装，使用最新技术栈 vue3 +## 简介 -#### 软件架构 +quick-vue3-admin 是一款免费开源快速搭建中后台系统框架。本框架基于 vite2+element-plus 等最新主流技术并封装了通用的组件方便开发者提高工作效率。后期也会通过版本升级的方式来维护并更新，使开发者拥有一款长期并且稳定的脚手架。 -quick-vue3-admin 是一套快速搭建后台系统框架，基于 vite2+element-plus 进行二次封装，使用最新技术栈 vue3 +## 软件特色 -##### 安装教程 +1. 使用前端最新技术栈 vite2、vue3 和 typescript +2. 封装了通用的组件 +3. 提供了系统管理常用功能模块 +4. 提供权限管理模块 +5. 动态菜单技术 +6. 动态路由技术 +7. 前后端分离 +8. 官方提供稳定并长期维护的后端接口项目 -##### 安装依赖 +## 预览 +- [quick-vue3-admin](https://ainiteam.com:3101/) - 框架演示 + +演示账号密码：admin/123456 + +## 文档 + +文档地址完善中 + +## 安装使用 + +- 克隆项目 + +```bash +git clone https://gitee.com/zhanglp520/quick-vue3-admin.git +``` + +- 安装 pnpm + +```bash +npm install -g pnpm +``` + +- 安装项目依赖包 + +```bash pnpm install +``` -##### 运行 +- 运行 +```bash pnpm run dev +``` + +运行命令执行服务启动后，浏览器输入：http://localhost:3001/ + +- eslint 检测 + +```bash +pnpm run lint 仅检测 -##### 打包 +pnpm run lint-fix 检测并尝试修复 +``` +- 打包上线 + +```bash pnpm run build +``` + +## 后端接口 -#### 使用说明 +官方提供后端接口项目：https://gitee.com/zhanglp520/quick-node-express.git -1. 开发地址 +## 寻求帮助 -http://localhost:3001/ +1. 百度尝试解决 +2. 发起 Issue +3. 加 quick 框架 QQ 群：558795174 -2. 部署地址 +## License -http://110.42.130.88:3001 +[MIT © quick-vue3-admin](./LICENSE) -#### 参与贡献 +## 参与贡献 1. Fork 本仓库 2. 新建 Feat_xxx 分支 3. 提交代码 4. 新建 Pull Request - -#### 特技 - -1. 使用 Readme_XXX.md 来支持不同的语言，例如 Readme_en.md, Readme_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +5. 点个 star 把 +6. 如果你觉得这个项目对你有帮助，你可以帮作者买一杯咖啡表示支持! + ![donate](./public/payImages/alipay.jpg) diff --git a/public/payImages/.keep b/public/payImages/.keep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git "a/public/payImages/QQ\345\233\276\347\211\20720220726001051.jpg" "b/public/payImages/QQ\345\233\276\347\211\20720220726001051.jpg" new file mode 100644 index 0000000000000000000000000000000000000000..3a7dd9d226f426a7ead67bcd616487bd1a0d4c2d Binary files /dev/null and "b/public/payImages/QQ\345\233\276\347\211\20720220726001051.jpg" differ diff --git a/public/payImages/alipay.jpg b/public/payImages/alipay.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3a7dd9d226f426a7ead67bcd616487bd1a0d4c2d Binary files /dev/null and b/public/payImages/alipay.jpg differ