From 109b029d9f9d65bdac4277e47b2e9db8b2629343 Mon Sep 17 00:00:00 2001 From: wangze <73400@163.com> Date: Wed, 13 Jan 2021 23:21:45 +0800 Subject: [PATCH] =?UTF-8?q?=E5=8A=A0=E5=85=A5RuoYi-Antdv=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- geekera-docs/.vuepress/config.js | 26 ++++++++++++- geekera-docs/.vuepress/nav/zh.js | 4 ++ geekera-docs/RuoYi-Antdv/README.md | 52 ++++++++++++++++++++++++++ geekera-docs/RuoYi-Antdv/dev-plan.md | 12 ++++++ geekera-docs/RuoYi-Antdv/directory.md | 29 ++++++++++++++ geekera-docs/RuoYi-Antdv/function.md | 25 +++++++++++++ geekera-docs/RuoYi-Antdv/show.md | 18 +++++++++ geekera-docs/RuoYi-Antdv/update-log.md | 10 +++++ geekera-docs/RuoYi-Antdv/use.md | 42 +++++++++++++++++++++ 9 files changed, 216 insertions(+), 2 deletions(-) create mode 100644 geekera-docs/RuoYi-Antdv/README.md create mode 100644 geekera-docs/RuoYi-Antdv/dev-plan.md create mode 100644 geekera-docs/RuoYi-Antdv/directory.md create mode 100644 geekera-docs/RuoYi-Antdv/function.md create mode 100644 geekera-docs/RuoYi-Antdv/show.md create mode 100644 geekera-docs/RuoYi-Antdv/update-log.md create mode 100644 geekera-docs/RuoYi-Antdv/use.md diff --git a/geekera-docs/.vuepress/config.js b/geekera-docs/.vuepress/config.js index 4cfc8cf..8d83983 100644 --- a/geekera-docs/.vuepress/config.js +++ b/geekera-docs/.vuepress/config.js @@ -36,6 +36,7 @@ module.exports = { nav: require('./nav/zh'), sidebarDepth: 2, sidebar: { + '/RuoYi-Antdv/': getRuoYiAntdvSidebar('基础', '其他'), '/gblog-wx/': getGblogwxSidebar('基础', '高级配置'), '/windpower/': getWindpowerSidebar('项目说明','TrendDB数据库','常见问题') } @@ -60,6 +61,28 @@ module.exports = { ] } +function getRuoYiAntdvSidebar(groupA, groupB) { + return [{ + title: groupA, + collapsable: false, + children: [ + '', + 'show', + 'use', + 'directory', + 'function' + ] + }, + { + title: groupB, + collapsable: false, + children: [ + 'update-log', + 'dev-plan' + ] + }] +} + function getGblogwxSidebar(groupA, groupB) { return [{ title: groupA, @@ -80,8 +103,7 @@ function getGblogwxSidebar(groupA, groupB) { 'custom-style', 'subscribe' ] - } -] + }] } function getWindpowerSidebar(groupA, groupB,groupC) { diff --git a/geekera-docs/.vuepress/nav/zh.js b/geekera-docs/.vuepress/nav/zh.js index 88ab88d..985e84f 100644 --- a/geekera-docs/.vuepress/nav/zh.js +++ b/geekera-docs/.vuepress/nav/zh.js @@ -1,4 +1,8 @@ module.exports = [ + { + text: 'RuoYi-Antdv', + link: '/RuoYi-Antdv/' + }, { text: 'GBlog-wx', link: '/gblog-wx/' diff --git a/geekera-docs/RuoYi-Antdv/README.md b/geekera-docs/RuoYi-Antdv/README.md new file mode 100644 index 0000000..5854ad1 --- /dev/null +++ b/geekera-docs/RuoYi-Antdv/README.md @@ -0,0 +1,52 @@ +--- +title: 简介 +--- +

RuoYi-Antdv

+ +> RuoYi-Antdv 是RuoYi-Vue和Ant Design Vue Pro的结合。 + +

+

+ Build Status + Build Status + Build Status + Build Status + Build Status +

+ +------------------------------ + + +## 简介 + +**RuoYi-Antdv**，使用[RuoYi-Vue](https://gitee.com/y_project/RuoYi-Vue)作为后端，改其原有Element Ui为Ant Design Vue。将会持续完全适配RuoYi-Vue。 + +> RuoYi-Vue是基于SpringBoot，Spring Security，JWT，Vue 的前后端分离权限管理系统。 +> +> 拥有用户管理、部门管理、岗位管理、菜单管理、角色管理、字典管理、参数管理、通知公告、操作日志、登录日志、在线用户、定时任务、代码生成、系统接口、服务监控、在线构建器、连接池监视等功能。 + +*当前暂不支持RuoYi中的在线构建器与前端代码生成功能。* + +* 预览：[https://ruoyi.setworld.net/](https://ruoyi.setworld.net/) + +* 文档: [https://docs.geekera.cn/RuoYi-Antdv/](https://docs.geekera.cn/RuoYi-Antdv/) + +* RuoYi-Vue文档: [https://doc.ruoyi.vip/ruoyi-vue/](https://doc.ruoyi.vip/ruoyi-vue/) + +* Ant Design Vue文档：[https://www.antdv.com/docs/vue/introduce-cn/](https://www.antdv.com/docs/vue/introduce-cn/) + +## 致谢 + +* [RuoYi-Vue](https://gitee.com/y_project/RuoYi-Vue) 基于SpringBoot，Spring Security，JWT，Vue 的前后端分离权限管理系统 +* [Ant Design Vue](https://github.com/vueComponent/ant-design-vue/) An enterprise-class UI components based on Ant Design and Vue. +* [Ant Design Vue Pro](https://github.com/vueComponent/ant-design-vue-pro) Use Ant Design Vue like a Pro + +* [vditor](https://github.com/Vanessa219/vditor) 一款浏览器端的 Markdown 编辑 + + + +## 联系 + +如果您发现了什么bug，或者有什么界面建议或意见， + +欢迎 [issue](https://github.com/fuzui/RuoYi-Antdv/issues) \ No newline at end of file diff --git a/geekera-docs/RuoYi-Antdv/dev-plan.md b/geekera-docs/RuoYi-Antdv/dev-plan.md new file mode 100644 index 0000000..b491827 --- /dev/null +++ b/geekera-docs/RuoYi-Antdv/dev-plan.md @@ -0,0 +1,12 @@ +--- +title: 开发计划 +--- +> 开发计划 + +# 2021 + +# 1月 +* :black_square_button: 去除多余依赖 +* :white_check_mark: 精简登录页，美化部分样式 +* :black_square_button: 重写`pro-layout` +* :black_square_button: 更改页头`pro-layout` diff --git a/geekera-docs/RuoYi-Antdv/directory.md b/geekera-docs/RuoYi-Antdv/directory.md new file mode 100644 index 0000000..76b61fc --- /dev/null +++ b/geekera-docs/RuoYi-Antdv/directory.md @@ -0,0 +1,29 @@ +--- +title: 代码结构 +--- + +``` +├── public +│ └── logo.png # LOGO +| └── index.html # Vue 入口模板 +├── src +│ ├── api # Api ajax 等 +│ ├── assets # 本地静态资源 +│ ├── config # 项目基础配置，包含路由，全局设置 +│ ├── components # 业务通用组件 +│ ├── core # 项目引导, 全局配置初始化，依赖包引入等 +│ ├── directive # 自定义指令 +│ ├── router # Vue-Router +│ ├── store # Vuex +│ ├── utils # 工具库 +│ ├── locales # 国际化资源 +│ ├── views # 业务页面入口和常用模板 +│ ├── App.vue # Vue 模板入口 +│ └── main.js # Vue 入口 JS +│ └── permission.js # 路由守卫(路由权限控制) +│ └── global.less # 全局样式 +├── tests # 测试工具 +├── README.md +└── package.json +``` + diff --git a/geekera-docs/RuoYi-Antdv/function.md b/geekera-docs/RuoYi-Antdv/function.md new file mode 100644 index 0000000..c6df120 --- /dev/null +++ b/geekera-docs/RuoYi-Antdv/function.md @@ -0,0 +1,25 @@ +--- +title: 功能 +--- + +[RuoYi-Vue](https://gitee.com/y_project/RuoYi-Vue) + +1. 用户管理：用户是系统操作者，该功能主要完成系统用户配置。 +2. 部门管理：配置系统组织机构（公司、部门、小组），树结构展现支持数据权限。 +3. 岗位管理：配置系统用户所属担任职务。 +4. 菜单管理：配置系统菜单，操作权限，按钮权限标识等。 +5. 角色管理：角色菜单权限分配、设置角色按机构进行数据范围权限划分。 +6. 字典管理：对系统中经常使用的一些较为固定的数据进行维护。 +7. 参数管理：对系统动态配置常用参数。 +8. 通知公告：系统通知公告信息发布维护。 +9. 操作日志：系统正常操作日志记录和查询；系统异常信息日志记录和查询。 +10. 登录日志：系统登录日志记录查询包含登录异常。 +11. 在线用户：当前系统中活跃用户状态监控。 +12. 定时任务：在线（添加、修改、删除)任务调度包含执行结果日志。 +13. 代码生成：前后端代码的生成（java、html、xml、sql）支持CRUD下载 。 +14. 系统接口：根据业务代码自动生成相关的api接口文档。 +15. 服务监控：监视当前系统CPU、内存、磁盘、堆栈等相关信息。 +16. 在线构建器：拖动表单元素生成相应的HTML代码。 +17. 连接池监视：监视当前系统数据库连接池状态，可进行分析SQL找出系统性能瓶颈。 + +> *当前暂不支持RuoYi中的在线构建器(16)与前端代码生成功能(13)。* \ No newline at end of file diff --git a/geekera-docs/RuoYi-Antdv/show.md b/geekera-docs/RuoYi-Antdv/show.md new file mode 100644 index 0000000..c054c17 --- /dev/null +++ b/geekera-docs/RuoYi-Antdv/show.md @@ -0,0 +1,18 @@ +--- +title: 展示图 +--- + + + + + + + + + + + + + + +
\ No newline at end of file diff --git a/geekera-docs/RuoYi-Antdv/update-log.md b/geekera-docs/RuoYi-Antdv/update-log.md new file mode 100644 index 0000000..6d8b0ab --- /dev/null +++ b/geekera-docs/RuoYi-Antdv/update-log.md @@ -0,0 +1,10 @@ +--- +title: 更新日志 +--- +> 更新日志 + + +## 2021 + +### 1.1 +> 首次提交 \ No newline at end of file diff --git a/geekera-docs/RuoYi-Antdv/use.md b/geekera-docs/RuoYi-Antdv/use.md new file mode 100644 index 0000000..a69fd1e --- /dev/null +++ b/geekera-docs/RuoYi-Antdv/use.md @@ -0,0 +1,42 @@ +--- +title: 搭建 +--- + +## 开始使用 + +1. 环境准备 + * 运行启动RuoYi-Vue，参考[RuoYi文档](https://doc.ruoyi.vip/ruoyi-vue/) + * 安装[node](http://nodejs.org/)和[git](https://git-scm.com/) + +1. 安装 + + ```shell + git clone git@gitee.com:fuzui/RuoYi-Antdv.git + ``` + + 或 + + ```shell + git clone git@github.com:fuzui/RuoYi-Antdv.git + ``` + +2. 本地开发 + + 进入项目根目录 + + ```shell + npm install + ``` + + > 若耗时太长可使用`npm install --registry=https://registry.npm.taobao.org` + + ```shell + npm run serve + ``` + + > 打开浏览器访问 [http://localhost:8000](http://localhost:8080/) + +## 自定义图标 + +## 优化建议 +* 线上环境去除主题配置 \ No newline at end of file -- GitLab