docs
This commit is contained in:
parent
7437057b17
commit
31fb28e17f
|
@ -0,0 +1,17 @@
|
||||||
|
.DS_Store
|
||||||
|
node_modules/
|
||||||
|
dist/
|
||||||
|
../.idea/
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
package-lock.json
|
||||||
|
yarn.lock
|
||||||
|
|
||||||
|
# Editor directories and files
|
||||||
|
.idea
|
||||||
|
.vscode
|
||||||
|
*.suo
|
||||||
|
*.ntvs*
|
||||||
|
*.njsproj
|
||||||
|
*.sln
|
|
@ -0,0 +1,8 @@
|
||||||
|
## 文档
|
||||||
|
文档基于vue-press实现,运行步骤:
|
||||||
|
|
||||||
|
1. npm install
|
||||||
|
|
||||||
|
2. npm run docs:dev
|
||||||
|
|
||||||
|
3. http://localhost:8080
|
|
@ -0,0 +1,14 @@
|
||||||
|
module.exports = {
|
||||||
|
base: '/doc/',
|
||||||
|
title: '大屏设计',
|
||||||
|
description: '使用拖拽快速生成动态大屏报表',
|
||||||
|
dest: 'dist',
|
||||||
|
lastUpdated: 'Last Updated',
|
||||||
|
theme: '',
|
||||||
|
themeConfig: {
|
||||||
|
logo: '/logo.png',
|
||||||
|
smoothScroll: true,
|
||||||
|
sidebarDepth: 2,
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
Binary file not shown.
After Width: | Height: | Size: 8.2 KiB |
|
@ -0,0 +1,23 @@
|
||||||
|
// placeholder for test, dont't remove it.
|
||||||
|
|
||||||
|
//.content {
|
||||||
|
// font-size 30px;
|
||||||
|
//}
|
||||||
|
|
||||||
|
pre.vue-container
|
||||||
|
border-left-width: .5rem;
|
||||||
|
border-left-style: solid;
|
||||||
|
border-color: #42b983;
|
||||||
|
border-radius: 0px;
|
||||||
|
& > code
|
||||||
|
font-size: 14px !important;
|
||||||
|
& > p
|
||||||
|
margin: -5px 0 -20px 0;
|
||||||
|
code
|
||||||
|
background-color: #42b983 !important;
|
||||||
|
padding: 3px 5px;
|
||||||
|
border-radius: 3px;
|
||||||
|
color #000
|
||||||
|
em
|
||||||
|
color #808080
|
||||||
|
font-weight light
|
|
@ -0,0 +1,25 @@
|
||||||
|
---
|
||||||
|
home: true
|
||||||
|
heroImage: /logo.png
|
||||||
|
actionText: 快速开始 →
|
||||||
|
actionLink: /guide/
|
||||||
|
footer: Apache 2.0 Licensed | Copyright © 2021 Anji-Plus Report All Rights Reserved
|
||||||
|
---
|
||||||
|
|
||||||
|
<div style="text-align: center">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="features">
|
||||||
|
<div class="feature">
|
||||||
|
<h2>技术先进</h2>
|
||||||
|
<p>使用最流行的技术SpringBoot、SpringCloud、Vue、Element。</p>
|
||||||
|
</div>
|
||||||
|
<div class="feature">
|
||||||
|
<h2>丰富组件</h2>
|
||||||
|
<p>是一个包含前后端代码实现,同时提供底盘和丰富功能组件的开发平台.</p>
|
||||||
|
</div>
|
||||||
|
<div class="feature">
|
||||||
|
<h2>功能完善</h2>
|
||||||
|
<p>支持多数据源,多数据集,丰富的UI组件实现拖拽生成大屏</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
|
@ -0,0 +1,25 @@
|
||||||
|
# 介绍
|
||||||
|
---
|
||||||
|
|
||||||
|
**大屏设计**
|
||||||
|
|
||||||
|
大屏设计(Report)是一个JavaEE微服务架构平台,采用经典组合(SpringBoot,SpringCloud,Vue,ElementUI)。目前提供两种架构,单体架构和微服务架构。
|
||||||
|
内置的基础功能包括数据源,数据集,报表管理
|
||||||
|
|
||||||
|
**功能架构**
|
||||||
|
- 前端
|
||||||
|
|
||||||
|
|
||||||
|
- 后端
|
||||||
|
|
||||||
|
|
||||||
|
**在线体验**
|
||||||
|
- 访问地址
|
||||||
|
|
||||||
|
- 默认账号密码
|
||||||
|
|
||||||
|
|
||||||
|
**联系我们**
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,44 @@
|
||||||
|
# 系统运行
|
||||||
|
微服务版本的系统运行,可以在本地开发环境下跑起来。
|
||||||
|
|
||||||
|
## 准备工作
|
||||||
|
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
|
||||||
|
```
|
|
@ -0,0 +1 @@
|
||||||
|
# 开发手册
|
|
@ -0,0 +1,77 @@
|
||||||
|
# 目录结构
|
||||||
|
|
||||||
|
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` |
|
||||||
|
|
|
@ -0,0 +1 @@
|
||||||
|
# 项目介绍
|
|
@ -0,0 +1,4 @@
|
||||||
|
# 常见问题
|
||||||
|
|
||||||
|
## 其他
|
||||||
|
|
|
@ -0,0 +1,34 @@
|
||||||
|
# 快速了解
|
||||||
|
---
|
||||||
|
## 项目简介
|
||||||
|
- 项目源代码地址: <https://gitee.com/anji-plus/report>
|
||||||
|
- 在线提问: <https://gitee.com/anji-plus/report/issues>
|
||||||
|
- 在线文档:
|
||||||
|
|
||||||
|
大屏设计(Report)是一个JavaEE微服务架构平台,采用经典组合(SpringBoot,SpringCloud,Vue,ElementUI)。目前提供两种架构,单体架构和微服务架构。
|
||||||
|
内置的基础功能包括数据源,数据集,报表管理
|
||||||
|
|
||||||
|
|
||||||
|
## 技术选型
|
||||||
|
|
||||||
|
**1.环境**
|
||||||
|
- JavaEE 8
|
||||||
|
- Apache Maven 3
|
||||||
|
|
||||||
|
**2.主框架**
|
||||||
|
- Spring Boot 2.3.x
|
||||||
|
- Spring Cloud Hoxton.SR9
|
||||||
|
- Spring Security 5.3.x
|
||||||
|
|
||||||
|
**3.持久层**
|
||||||
|
- Apache MyBatis 3.5.x
|
||||||
|
|
||||||
|
**4.视图层**
|
||||||
|
- Vue 2.6.10+
|
||||||
|
- ElementUI 2.13.0+
|
||||||
|
|
||||||
|
|
||||||
|
## 系统特性
|
||||||
|
1. 最新最稳定的技术栈;
|
||||||
|
2. 支持多数据源配置
|
||||||
|
3. 丰富的大屏组件。拖拽配置实现动态大屏
|
|
@ -0,0 +1,18 @@
|
||||||
|
{
|
||||||
|
"name": "doc",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"description": "AJ Report Doc",
|
||||||
|
"devDependencies": {
|
||||||
|
"vuepress": "^1.8.2"
|
||||||
|
},
|
||||||
|
"keywords": [
|
||||||
|
"AJ-Report",
|
||||||
|
"Report-Archiver"
|
||||||
|
],
|
||||||
|
"author": "anji-plus report team",
|
||||||
|
"license": "Apache-2.0",
|
||||||
|
"scripts": {
|
||||||
|
"docs:dev": "vuepress dev docs",
|
||||||
|
"docs:build": "vuepress build docs"
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in New Issue