From 18fb98fd37c364822fbbdbdefb79727bfe38cd0e Mon Sep 17 00:00:00 2001 From: Raod <1130305001@qq.com> Date: Wed, 23 Jun 2021 17:02:39 +0800 Subject: [PATCH] doc --- doc/docs/.vuepress/config.js | 36 ++++++++++++----- doc/docs/guide/devdoc.md | 1 - doc/docs/guide/productintro.md | 68 ++++++++++++++++++++++++++++++++ doc/docs/guide/quickly.md | 6 +-- doc/docs/operation/README.md | 25 ++++++++++++ doc/docs/operation/dashboard.md | 32 +++++++++++++++ doc/docs/operation/dataset.md | 32 +++++++++++++++ doc/docs/operation/datasource.md | 3 ++ doc/docs/operation/dict.md | 32 +++++++++++++++ doc/docs/operation/i18n.md | 32 +++++++++++++++ 10 files changed, 253 insertions(+), 14 deletions(-) delete mode 100644 doc/docs/guide/devdoc.md create mode 100644 doc/docs/operation/README.md create mode 100644 doc/docs/operation/dashboard.md create mode 100644 doc/docs/operation/dataset.md create mode 100644 doc/docs/operation/datasource.md create mode 100644 doc/docs/operation/dict.md create mode 100644 doc/docs/operation/i18n.md diff --git a/doc/docs/.vuepress/config.js b/doc/docs/.vuepress/config.js index b6deb7e..0f49c01 100644 --- a/doc/docs/.vuepress/config.js +++ b/doc/docs/.vuepress/config.js @@ -11,7 +11,8 @@ module.exports = { sidebarDepth: 2, nav: [ {text: '首页', link: '/'}, - {text: '文档', link: '/guide/'}, + {text: '指南', link: '/guide/'}, + {text: '操作手册', link: '/operation/'}, {text: 'GitHub', link: 'https://github.com/anji-plus/report'}, {text: 'Gitee', link: 'https://gitee.com/anji-plus/report'}, ], @@ -22,17 +23,11 @@ module.exports = { collapsable: false, children: [ {title: '介绍', path: '/guide/'}, - {title: '快速了解', path: '/guide/quickly'}, + {title: '快速入门', path: '/guide/quickly'}, {title: '项目介绍', path: '/guide/productintro'}, - {title: '系统运行', path: '/guide/deploy'}, - {title: '开发手册', path: '/guide/devdoc'} + {title: '系统运行', path: '/guide/deploy'} ] }, - { - title: '盖亚底盘', - collapsable: false, - children: [] - }, { title: '其他', collapsable: false, @@ -40,6 +35,29 @@ module.exports = { {title: '常见问题', path: '/guide/question'} ] }], + '/operation/': [ + { + title: '操作手册', + collapsable: false, + children: [ + {title: '数据源', path: '/operation/datasource'}, + {title: '数据集', path: '/operation/dataset'}, + {title: '大屏设计', path: '/operation/dashboard'}, + {title: '国际化', path: '/operation/i18n'}, + {title: '字典', path: '/operation/dict'}, + ] + } + ] + } + }, + plugins: [ + ['@vuepress/back-to-top', true], + ], + configureWebpack: { + resolve: { + alias: { + '@': '/.vuepress/public' + } } } } diff --git a/doc/docs/guide/devdoc.md b/doc/docs/guide/devdoc.md deleted file mode 100644 index a5b829e..0000000 --- a/doc/docs/guide/devdoc.md +++ /dev/null @@ -1 +0,0 @@ -# 开发手册 diff --git a/doc/docs/guide/productintro.md b/doc/docs/guide/productintro.md index 1476139..ef1ff01 100644 --- a/doc/docs/guide/productintro.md +++ b/doc/docs/guide/productintro.md @@ -1 +1,69 @@ # 项目介绍 + +# 项目介绍 +在线拖拽大屏设计，后续会持续更新新的功能。 + + +## 文件结构 +### 系统目录 +- +``` +├── doc 文档源码 +│ ├── docs +│ ├── package.json +│ └── README.md +├── pom.xml 父pom，jar版本管理 +├── report-core java源码 +│ ├── pom.xml gaea父pom，jar版本管理 +│ └── README.md +├── report-ui 前端vue源码 +├── LICENSE +├── README.md +``` +### 前端 +``` +├── build # 构建相关 +├── mock # 项目mock 模拟数据 +├── public # 静态资源 +│ │── favicon.ico # favicon图标 +│ └── index.html # html模板 +├── src # 源代码 +│ ├── api # 所有请求 +│ ├── assets # 主题 字体等静态资源 +│ ├── components # 全局公用组件 +│ ├── directive # 全局指令 +│ ├── icons # 项目所有 svg icons +│ ├── lang # 国际化 language +│ ├── layout # 全局 layout +│ ├── router # 路由 +│ ├── store # 全局 store管理 +│ ├── styles # 全局样式 +│ ├── utils # 全局公用方法 +│ ├── views # views 所有页面 +│ ├── App.vue # 入口页面 +│ ├── main.js # 入口文件 加载组件 初始化等 +│ └── permission.js # 权限管理 +├── .env.xxx # 环境变量配置 +├── .eslintrc.js # eslint 配置项 +├── .babelrc # babel-loader 配置 +├── .travis.yml # 自动化CI配置 +├── vue.config.js # vue-cli 配置 +├── postcss.config.js # postcss 配置 +└── package.json # package.json +``` + +## 核心技术 +### 后端 +- [Spring Boot](https://spring.io/projects/spring-boot/): Spring Boot是一款开箱即用框架，让我们的Spring应用变的更轻量化、更快的入门。 在主程序执行main函数就可以运行。你也可以打包你的应用为jar并通过使用java -jar来运行你的Web应用； +- [Mybatis-plus](https://mp.baomidou.com/): MyBatis-plus（简称 MP）是一个 MyBatis (opens new window) 的增强工具。 +- [flyway](https://flywaydb.org/): 主要用于在你的应用版本不断升级的同时，升级你的数据库结构和里面的数据 +### 前端 +- [npm](https://www.npmjs.com/)：node.js的包管理工具，用于统一管理我们前端项目中需要用到的包、插件、工具、命令等，便于开发和维护。 +- [webpack](https://webpack.docschina.org/)：用于现代 JavaScript 应用程序的_静态模块打包工具 +- [ES6](https://es6.ruanyifeng.com/)：Javascript的新版本，ECMAScript6的简称。利用ES6我们可以简化我们的JS代码，同时利用其提供的强大功能来快速实现JS逻辑。 +- [vue-cli](https://cli.vuejs.org/)：Vue的脚手架工具，用于自动生成Vue项目的目录及文件。 +- [vue-router](https://router.vuejs.org/)： Vue提供的前端路由工具，利用其我们实现页面的路由控制，局部刷新及按需加载，构建单页应用，实现前后端分离。 +- [vuex](https://vuex.vuejs.org/)：Vue提供的状态管理工具，用于统一管理我们项目中各种数据的交互和重用，存储我们需要用到数据对象。 +- [element-ui](https://element.eleme.cn/#/zh-CN)：基于MVVM框架Vue开源出来的一套前端ui组件。 +- [vue-element-admin](https://panjiachen.gitee.io/vue-element-admin-site/)：后台前端解决方案,它基于 vue 和 element-ui实现 + diff --git a/doc/docs/guide/quickly.md b/doc/docs/guide/quickly.md index 3a1c4b8..f50cb74 100644 --- a/doc/docs/guide/quickly.md +++ b/doc/docs/guide/quickly.md @@ -5,8 +5,8 @@ - 在线提问: - 在线文档: -大屏设计（Report）是一个JavaEE微服务架构平台，采用经典组合（SpringBoot，SpringCloud，Vue，ElementUI）。目前提供两种架构，单体架构和微服务架构。 -内置的基础功能包括数据源，数据集，报表管理 +大屏设计（Report）是一个可视化拖拽编辑的，直观，酷炫，具有科技感的图表工具项目。 +内置的基础功能包括数据源，数据集，国际化，字典管理，报表管理 ## 技术选型 @@ -17,8 +17,6 @@ **2.主框架** - Spring Boot 2.3.x -- Spring Cloud Hoxton.SR9 -- Spring Security 5.3.x **3.持久层** - Apache MyBatis 3.5.x diff --git a/doc/docs/operation/README.md b/doc/docs/operation/README.md new file mode 100644 index 0000000..1520bf7 --- /dev/null +++ b/doc/docs/operation/README.md @@ -0,0 +1,25 @@ +# 介绍 +--- + +**大屏设计** + +大屏设计（Report）是一个JavaEE微服务架构平台，采用经典组合（SpringBoot，SpringCloud，Vue，ElementUI）。目前提供两种架构，单体架构和微服务架构。 +内置的基础功能包括数据源，数据集，报表管理 + +**功能架构** +- 前端 + + +- 后端 + + +**在线体验** +- 访问地址 + +- 默认账号密码 + + +**联系我们** + + + diff --git a/doc/docs/operation/dashboard.md b/doc/docs/operation/dashboard.md new file mode 100644 index 0000000..f50cb74 --- /dev/null +++ b/doc/docs/operation/dashboard.md @@ -0,0 +1,32 @@ +# 快速了解 +--- +## 项目简介 +- 项目源代码地址: +- 在线提问: +- 在线文档: + +大屏设计（Report）是一个可视化拖拽编辑的，直观，酷炫，具有科技感的图表工具项目。 +内置的基础功能包括数据源，数据集，国际化，字典管理，报表管理 + + +## 技术选型 + +**1.环境** +- JavaEE 8 +- Apache Maven 3 + +**2.主框架** +- Spring Boot 2.3.x + +**3.持久层** +- Apache MyBatis 3.5.x + +**4.视图层** +- Vue 2.6.10+ +- ElementUI 2.13.0+ + + +## 系统特性 +1. 最新最稳定的技术栈； +2. 支持多数据源配置 +3. 丰富的大屏组件。拖拽配置实现动态大屏 diff --git a/doc/docs/operation/dataset.md b/doc/docs/operation/dataset.md new file mode 100644 index 0000000..f50cb74 --- /dev/null +++ b/doc/docs/operation/dataset.md @@ -0,0 +1,32 @@ +# 快速了解 +--- +## 项目简介 +- 项目源代码地址: +- 在线提问: +- 在线文档: + +大屏设计（Report）是一个可视化拖拽编辑的，直观，酷炫，具有科技感的图表工具项目。 +内置的基础功能包括数据源，数据集，国际化，字典管理，报表管理 + + +## 技术选型 + +**1.环境** +- JavaEE 8 +- Apache Maven 3 + +**2.主框架** +- Spring Boot 2.3.x + +**3.持久层** +- Apache MyBatis 3.5.x + +**4.视图层** +- Vue 2.6.10+ +- ElementUI 2.13.0+ + + +## 系统特性 +1. 最新最稳定的技术栈； +2. 支持多数据源配置 +3. 丰富的大屏组件。拖拽配置实现动态大屏 diff --git a/doc/docs/operation/datasource.md b/doc/docs/operation/datasource.md new file mode 100644 index 0000000..3625ab1 --- /dev/null +++ b/doc/docs/operation/datasource.md @@ -0,0 +1,3 @@ +# 数据源 + +## 标题一 diff --git a/doc/docs/operation/dict.md b/doc/docs/operation/dict.md new file mode 100644 index 0000000..f50cb74 --- /dev/null +++ b/doc/docs/operation/dict.md @@ -0,0 +1,32 @@ +# 快速了解 +--- +## 项目简介 +- 项目源代码地址: +- 在线提问: +- 在线文档: + +大屏设计（Report）是一个可视化拖拽编辑的，直观，酷炫，具有科技感的图表工具项目。 +内置的基础功能包括数据源，数据集，国际化，字典管理，报表管理 + + +## 技术选型 + +**1.环境** +- JavaEE 8 +- Apache Maven 3 + +**2.主框架** +- Spring Boot 2.3.x + +**3.持久层** +- Apache MyBatis 3.5.x + +**4.视图层** +- Vue 2.6.10+ +- ElementUI 2.13.0+ + + +## 系统特性 +1. 最新最稳定的技术栈； +2. 支持多数据源配置 +3. 丰富的大屏组件。拖拽配置实现动态大屏 diff --git a/doc/docs/operation/i18n.md b/doc/docs/operation/i18n.md new file mode 100644 index 0000000..f50cb74 --- /dev/null +++ b/doc/docs/operation/i18n.md @@ -0,0 +1,32 @@ +# 快速了解 +--- +## 项目简介 +- 项目源代码地址: +- 在线提问: +- 在线文档: + +大屏设计（Report）是一个可视化拖拽编辑的，直观，酷炫，具有科技感的图表工具项目。 +内置的基础功能包括数据源，数据集，国际化，字典管理，报表管理 + + +## 技术选型 + +**1.环境** +- JavaEE 8 +- Apache Maven 3 + +**2.主框架** +- Spring Boot 2.3.x + +**3.持久层** +- Apache MyBatis 3.5.x + +**4.视图层** +- Vue 2.6.10+ +- ElementUI 2.13.0+ + + +## 系统特性 +1. 最新最稳定的技术栈； +2. 支持多数据源配置 +3. 丰富的大屏组件。拖拽配置实现动态大屏