doc
This commit is contained in:
Raod
parent
a454233bcb
commit
5fe710231c
|
|
@ -43,7 +43,10 @@
|
|||
|
||||
|
||||
## 近期计划
|
||||
####   丰富更多图表组件
|
||||
- 完善地图插件
|
||||
- 完善表格插件
|
||||
- 丰富自定义框图、装饰
|
||||
- 丰富更多图表组件
|
||||
|
||||
## 技术支持
|
||||
如有问题，请提交 [Issue](https://gitee.com/anji-plus/report/issues)
|
||||
|
|
|
|||
|
|
@ -1,32 +1,2 @@
|
|||
# 快速了解
|
||||
---
|
||||
## 项目简介
|
||||
- 项目源代码地址: <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+
|
||||
|
||||
|
||||
## 系统特性
|
||||
1. 最新最稳定的技术栈；
|
||||
2. 支持多数据源配置
|
||||
3. 丰富的大屏组件。拖拽配置实现动态大屏
|
||||
## 介绍
|
||||
待完善
|
||||
|
|
|
|||
|
|
@ -1,32 +1,2 @@
|
|||
# 快速了解
|
||||
---
|
||||
## 项目简介
|
||||
- 项目源代码地址: <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+
|
||||
|
||||
|
||||
## 系统特性
|
||||
1. 最新最稳定的技术栈；
|
||||
2. 支持多数据源配置
|
||||
3. 丰富的大屏组件。拖拽配置实现动态大屏
|
||||
## 介绍
|
||||
待完善
|
||||
|
|
|
|||
|
|
@ -1,44 +0,0 @@
|
|||
# 系统运行
|
||||
微服务版本的系统运行,可以在本地开发环境下跑起来。
|
||||
|
||||
## 准备工作
|
||||
1. 环境准备
|
||||
- JDK >= 1.8 (推荐1.8版本)
|
||||
- Mysql >= 5.7.0 (推荐5.7版本)
|
||||
- Redis >= 3.0
|
||||
- Maven >= 3.0
|
||||
- Node >= 10
|
||||
- Nacos >= 1.1.0
|
||||
|
||||
2. 从gitee上拉取下载项目源码,并解压到工作目录;
|
||||
|
||||
<https://gitee.com/anji-plus/report.git>
|
||||
|
||||
## 运行系统
|
||||
### 后端运行
|
||||
|
||||
|
||||
### 前端运行
|
||||
|
||||
2. 浏览器访问
|
||||
|
||||
3. 发布
|
||||
```
|
||||
# 构建生产环境
|
||||
npm run build:prod
|
||||
```
|
||||
|
||||
4. 其他
|
||||
```
|
||||
# 预览发布环境效果
|
||||
npm run preview
|
||||
|
||||
# 预览发布环境效果 + 静态资源分析
|
||||
npm run preview -- --report
|
||||
|
||||
# 代码格式检查
|
||||
npm run lint
|
||||
|
||||
# 代码格式检查并自动修复
|
||||
npm run lint -- --fix
|
||||
```
|
||||
|
|
@ -1,77 +0,0 @@
|
|||
# 目录结构
|
||||
|
||||
VuePress 遵循 **“约定优于配置”** 的原则，推荐的目录结构如下：
|
||||
|
||||
```
|
||||
.
|
||||
├── docs
|
||||
│ ├── .vuepress _(**可选的**)_
|
||||
│ │ ├── `components` _(**可选的**)_
|
||||
│ │ ├── `theme` _(**可选的**)_
|
||||
│ │ │ └── Layout.vue
|
||||
│ │ ├── `public` _(**可选的**)_
|
||||
│ │ ├── `styles` _(**可选的**)_
|
||||
│ │ │ ├── index.styl
|
||||
│ │ │ └── palette.styl
|
||||
│ │ ├── `templates` _(**可选的, 谨慎配置**)_
|
||||
│ │ │ ├── dev.html
|
||||
│ │ │ └── ssr.html
|
||||
│ │ ├── `config.js` _(**可选的**)_
|
||||
│ │ └── `enhanceApp.js` _(**可选的**)_
|
||||
│ │
|
||||
│ ├── README.md
|
||||
│ ├── guide
|
||||
│ │ └── README.md
|
||||
│ └── config.md
|
||||
│
|
||||
└── package.json
|
||||
```
|
||||
|
||||
::: warning 注意
|
||||
请留意目录名的大写。
|
||||
:::
|
||||
|
||||
- `docs/.vuepress`: 用于存放全局的配置、组件、静态资源等。
|
||||
- `docs/.vuepress/components`: 该目录中的 Vue 组件将会被自动注册为全局组件。
|
||||
- `docs/.vuepress/theme`: 用于存放本地主题。
|
||||
- `docs/.vuepress/styles`: 用于存放样式相关的文件。
|
||||
- `docs/.vuepress/styles/index.styl`: 将会被自动应用的全局样式文件，会生成在最终的 CSS 文件结尾，具有比默认样式更高的优先级。
|
||||
- `docs/.vuepress/styles/palette.styl`: 用于重写默认颜色常量，或者设置新的 stylus 颜色常量。
|
||||
- `docs/.vuepress/public`: 静态资源目录。
|
||||
- `docs/.vuepress/templates`: 存储 HTML 模板文件。
|
||||
- `docs/.vuepress/templates/dev.html`: 用于开发环境的 HTML 模板文件。
|
||||
- `docs/.vuepress/templates/ssr.html`: 构建时基于 Vue SSR 的 HTML 模板文件。
|
||||
- `docs/.vuepress/config.js`: 配置文件的入口文件，也可以是 `YML` 或 `toml`。
|
||||
- `docs/.vuepress/enhanceApp.js`: 客户端应用的增强。
|
||||
|
||||
::: warning 注意
|
||||
当你想要去自定义 `templates/ssr.html` 或 `templates/dev.html` 时，最好基于 [默认的模板文件](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/client/index.dev.html) 来修改，否则可能会导致构建出错。
|
||||
:::
|
||||
|
||||
**同时阅读:**
|
||||
|
||||
- [配置](../config/README.md)
|
||||
- [主题](../theme/README.md)
|
||||
- [默认主题配置](../theme/default-theme-config.md)
|
||||
|
||||
## 默认的页面路由
|
||||
|
||||
此处我们把 `docs` 目录作为 `targetDir` （参考 [命令行接口](../api/cli.md#基本用法)），下面所有的“文件的相对路径”都是相对于 `docs` 目录的。在项目根目录下的 `package.json` 中添加 `scripts` ：
|
||||
|
||||
```json
|
||||
{
|
||||
"scripts": {
|
||||
"dev": "vuepress dev docs",
|
||||
"build": "vuepress build docs"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
对于上述的目录结构，默认页面路由地址如下：
|
||||
|
||||
| 文件的相对路径 | 页面路由地址 |
|
||||
|--------------------|----------------|
|
||||
| `/README.md` | `/` |
|
||||
| `/guide/README.md` | `/guide/` |
|
||||
| `/config.md` | `/config.html` |
|
||||
|
||||
|
|
@ -6,7 +6,6 @@
|
|||
第四步，访问 http://localhost:9095/index.html
|
||||
```
|
||||
|
||||
|
||||
## 系统特性
|
||||
1. 最新最稳定的技术栈；
|
||||
2. 支持多数据源配置
|
||||
|
|
|
|||
Loading…
Reference in New Issue