Raod 4 年之前
父節點
當前提交
49ce3f368c
共有 4 個文件被更改,包括 72 次插入119 次删除
  1. 1 2
      doc/docs/.vuepress/config.js
  2. 48 22
      doc/docs/guide/README.md
  3. 0 69
      doc/docs/guide/productintro.md
  4. 23 26
      doc/docs/guide/quickly.md

+ 1 - 2
doc/docs/.vuepress/config.js

@@ -24,8 +24,7 @@ module.exports = {
                     children: [
                         {title: '介绍', path: '/guide/'},
                         {title: '快速入门', path: '/guide/quickly'},
-                        {title: '项目介绍', path: '/guide/productintro'},
-                        {title: '系统运行', path: '/guide/deploy'}
+                        // {title: '系统运行', path: '/guide/deploy'}
                     ]
                 },
                 {

+ 48 - 22
doc/docs/guide/README.md

@@ -1,25 +1,51 @@
-# 介绍
----
-
-**大屏设计**
-
-大屏设计(Report)是一个JavaEE微服务架构平台,采用经典组合(SpringBoot,SpringCloud,Vue,ElementUI)。目前提供两种架构,单体架构和微服务架构。
-内置的基础功能包括数据源,数据集,报表管理
-
-**功能架构**
-- 前端
-
-
-- 后端
-
-
-**在线体验**
-- 访问地址
-
-- 默认账号密码
-
-
-**联系我们**
+## 在线体验
+####    电脑在线体验: [https://report.anji-plus.com/](https://report.anji-plus.com/ "链接")   体验账号:guest  密码:guest
+#### &emsp;  在线文档: [https://report.anji-plus.com/#/doc](https://report.anji-plus.com/#/doc "doc")<br>
+#### &emsp;  在线提问: [https://gitee.com/anji-plus/report/issues](https://gitee.com/anji-plus/report/issues "issue")
+
+## 功能概述
+#### &emsp;  组件介绍
+&emsp;&emsp; 大屏设计(AJ-Report)是一个可视化拖拽编辑的,直观,酷炫,具有科技感的图表工具全开源项目。
+内置的基础功能包括数据源,数据集,报表管理,项目部分截图如下。<br>
+
+
+## 打包目录
+```
+├── bin                                           启动命令脚本
+│   ├── logs                                      启动日志目录
+│   ├── cache                                     本地缓存目录
+│   ├── startup.cmd
+│   ├── shutdown.cmd
+│   ├── startup.sh
+│   └── shutdown.sh
+├── config                                        配置文件目录
+├── lib                                           自定义扩展包
+├── target                                        report-core核心包
+```
+
+## 系统目录
+```
+├── 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
+```
+
+
+## 近期计划
+#### &emsp;  丰富更多图表组件
+
+## 技术支持
+如有问题,请提交 [Issue](https://gitee.com/anji-plus/report/issues)
+
+#### 开源不易,劳烦各位star ☺
 
 
 

+ 0 - 69
doc/docs/guide/productintro.md

@@ -1,69 +0,0 @@
-# 项目介绍
-
-# 项目介绍
-在线拖拽大屏设计,后续会持续更新新的功能。
-
-
-## 文件结构
-### 系统目录
-- 
-```
-├── 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实现
-

+ 23 - 26
doc/docs/guide/quickly.md

@@ -1,32 +1,29 @@
-# 快速了解
----
-## 项目简介
-- 项目源代码地址: <https://gitee.com/anji-plus/report>
-- 在线提问: <https://gitee.com/anji-plus/report/issues>
-- 在线文档: 
-
-大屏设计(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+
+## 快速部署
+```js
+ 第一步,下载zip包,解压<br>
+ 第二步,config->application.properties,修改mysql连接<br>
+ 第三步,启动bin目录下startup.cmd(Windows)或者startup.sh(Linux)<br>
+ 第四步,访问 http://localhost:9095/index.html
+```
 
 
 ## 系统特性
 1. 最新最稳定的技术栈;
 2. 支持多数据源配置
 3. 丰富的大屏组件。拖拽配置实现动态大屏
+
+## 核心技术
+### 后端
+- [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组件。
+- [avue](https://www.avuejs.com/): 用该组件包裹后可以变成拖拽组件,采用相对于父类绝对定位;用键盘的上下左右也可以控制移动
+