From 02be24359b81fc8738904956868976f2e1249270 Mon Sep 17 00:00:00 2001 From: valarchie <343928303@qq.com> Date: Tue, 15 Aug 2023 09:01:23 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E4=BF=AE=E6=94=B9readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 117 ++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 82 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 5663c39..eb0a02e 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,55 @@ -

vue-pure-admin精简版（非国际化版本）

+

+ Downloads + Build Status + Build Status + Downloads + + Downloads + + + Downloads + +

+

-[![license](https://img.shields.io/github/license/pure-admin/vue-pure-admin.svg)](LICENSE) +logo +

+

AgileBoot v2.0.0

-**中文** | [English](./README.en-US.md) +

基于SpringBoot+Vue3前后端分离的Java快速开发框架

+

+

-## 介绍 +## ⚡ 平台简介 ⚡ -精简版是基于 [vue-pure-admin](https://github.com/pure-admin/vue-pure-admin) 提炼出的架子，包含主体功能，更适合实际项目开发，打包后的大小在全局引入 [element-plus](https://element-plus.org) 的情况下仍然低于 `2.3MB`，并且会永久同步完整版的代码。开启 `brotli` 压缩和 `cdn` 替换本地库模式后，打包大小低于 `350kb` +- 本仓库是 Agilboot 快速开发脚手架的配套前端项目。前端是基于优秀的开源项目[Pure-Admin](https://github.com/pure-admin/vue-pure-admin)开发而成。在此感谢 Pure-Admin 作者。 +- 本仓库前端技术栈 [Vue3](https://v3.cn.vuejs.org) + [Element Plus](https://element-plus.org/zh-CN) + [Vite](https://cn.vitejs.dev) 版本。 +- 配套后端代码仓库地址[AgileBoot-Back-End](https://github.com/valarchie/AgileBoot-Back-End) 版本。 -## 版本选择 +- 规范请参照该文档 [前端规范](https://gitee.com/MinJieLiu/web-standard#/MinJieLiu/web-standard) -当前是非国际化版本，如果您需要国际化版本 [请点击](https://github.com/pure-admin/pure-admin-thin/tree/i18n) +### 前端配套资料 -## 配套视频 +#### 配套视频 - [点我查看教程](https://www.bilibili.com/video/BV1kg411v7QT) - [点我查看 UI 设计](https://www.bilibili.com/video/BV17g411T7rq) -## 配套保姆级文档 +#### 配套保姆级文档 - [查看文档](https://yiming_chang.gitee.io/pure-admin-doc) -## 预览 +#### Pure-Admin 框架预览 - [查看预览](https://pure-admin-thin.netlify.app/#/login) -## 维护者 +#### Pure-Admin 维护者 -[xiaoxian521](https://github.com/xiaoxian521) +- [xiaoxian521](https://github.com/xiaoxian521) -## 支持 +## ✨ 使用 ✨ -如果你觉得这个项目对您有帮助，可以帮作者买一杯果汁 🍹 表示支持 - - - -## `QQ` 交流群 - -[点击去加入](https://yiming_chang.gitee.io/pure-admin-doc/pages/support/#qq-%E4%BA%A4%E6%B5%81%E7%BE%A4) - -## 开发环境 +### 开发环境 node 版本应不小于 16 ，pnpm 版本应不小于 6 版本请勿过新，有先选择 node=16, pnpm=7.30.5 @@ -68,28 +78,65 @@ npm config set registry https://registry.npmmirror.com 上面的命令是将本地的源换成国内源 npmmirror (opens new window)，经过几轮测试，发现它的下载速度快且同步率高，同步频率 10 分钟一次，如果您之前的源是这个 http://registry.npm.taobao.org ，那您必须换成 npmmirror 啦，因为原淘宝 npm 域名即将停止解析 -## 用法 +## 🙊 系统内置功能 🙊 -### 安装依赖 +🙂 大部分功能，均有通过 **单元测试** **集成测试** 保证质量。 +| | 功能 | 描述 | +| --- | ---------- | ------------------------------------------------------------- | +| | 用户管理 | 用户是系统操作者，该功能主要完成系统用户配置 | +| ⭐ | 部门管理 | 配置系统组织机构（公司、部门、小组），树结构展现支持数据权限 | +| ⭐ | 岗位管理 | 配置系统用户所属担任职务 | +| | 菜单管理 | 配置系统菜单、操作权限、按钮权限标识等，本地缓存提供性能 | +| ⭐ | 角色管理 | 角色菜单权限分配、设置角色按机构进行数据范围权限划分 | +| | 参数管理 | 对系统动态配置常用参数 | +| | 通知公告 | 系统通知公告信息发布维护 | +| 🚀 | 操作日志 | 系统正常操作日志记录和查询；系统异常信息日志记录和查询 | +| | 登录日志 | 系统登录日志记录查询包含登录异常 | +| | 在线用户 | 当前系统中活跃用户状态监控 | +| | 系统接口 | 根据业务代码自动生成相关的 api 接口文档 | +| | 服务监控 | 监视当前系统 CPU、内存、磁盘、堆栈等相关信息 | +| | 缓存监控 | 对系统的缓存信息查询，命令统计等 | +| | 连接池监视 | 监视当前系统数据库连接池状态，可进行分析 SQL 找出系统性能瓶颈 | + +## 💥 在线体验 💥 + +演示地址： + +- +- + > 账号密码：admin/admin123 + +[项目文档](https://juejin.cn/column/7159946528827080734) + +## 🎬 AgileBoot 全栈交流群 🎬 + +QQ 群： [![加入QQ群](https://img.shields.io/badge/1398880-blue.svg)](https://qm.qq.com/cgi-bin/qm/qr?k=TR5guoXS0HssErVWefmdFRirJvfpEvp1&jump_from=webapi&authKey=VkWMmVhp/pNdWuRD8sqgM+Sv2+Vy2qCJQSeLmeXlLtfER2RJBi6zL56PdcRlCmTs) 点击按钮入群。 + +如果觉得该项目对您有帮助，可以小额捐赠支持本项目演示网站服务器等费用~ + +logo + +### 用法 + +#### 安装依赖 + +``` pnpm install +``` -### 安装一个包 +#### 安装一个包 +``` pnpm add 包名 +``` -### 卸载一个包 +#### 卸载一个包 +``` pnpm remove 包名 +``` -我认为你应该先 `fork` 项目去开发，以便我更新时您可以同步拉取更新！！！ - -## ⚠️ 注意 - -- 精简版不接受任何 `issues` 和 `pr`，如果有问题请到完整版 [issues](https://github.com/pure-admin/vue-pure-admin/issues/new/choose) 去提，谢谢！ - -## 许可证 +### 许可证 原则上不收取任何费用及版权，可商用，不过如需二次开源（比如用此平台二次开发并开源，要求前端代码必须开源免费）请联系作者获取许可！（免费，走个记录而已） - -[MIT © 2020-present, pure-admin](./LICENSE)