Browse Source

简化部署文档

pull/2/head
dailidong 6 years ago
parent
commit
96840f632a
  1. 13
      docs/zh_CN/SUMMARY.md
  2. 99
      docs/zh_CN/前端开发文档.md
  3. 2
      docs/zh_CN/后端部署文档.md

13
docs/zh_CN/SUMMARY.md

@ -2,17 +2,16 @@
* [Easyscheduler简介](README.md)
* 前端部署文档
* [环境搭建](前端部署文档.md#前端项目环境构建及编译)
* [安装及配置](前端部署文档.md#安装及配置)
* [项目生产环境Nginx配置](前端部署文档.md#项目生产环境配置)
* [前端项目发布](前端部署文档.md#前端项目发布)
* [问题](前端部署文档.md#问题)
* [准备工作](前端部署文档.md#1、准备工作)
* [部署](前端部署文档.md#2、部署)
* [常见问题](前端部署文档.md#前端常见问题)
* 后端部署文档
* [后端部署文档](后端部署文档.md#部署文档)
* [准备工作](后端部署文档.md#1、准备工作)
* [部署](后端部署文档.md#2、部署)
* [系统使用手册](系统使用手册.md#使用手册)
* [系统架构设计](系统架构设计.md#系统架构设计)
* 前端开发文档
* [开发环境搭建](前端部署文档.md)
* [开发环境搭建](前端开发文档.md#开发环境搭建)
* [项目目录结构](前端开发文档.md#项目目录结构)
* [系统功能模块](前端开发文档.md#系统功能模块)
* [路由和状态管理](前端开发文档.md#路由和状态管理)

99
docs/zh_CN/前端开发文档.md

@ -15,55 +15,6 @@ Jsplumb 连线插件库
Lodash 高性能的 JavaScript 实用工具库
```
### 项目目录结构
`build` 打包及开发环境项目的一些webpack配置
`node_modules` 开发环境node依赖包
`src` 项目所需文件
`src => combo` 项目第三方资源本地化 `npm run combo`具体查看`build/combo.js`
`src => font` 字体图标库可访问 https://www.iconfont.cn 进行添加 注意:字体库用的自己的 二次开发需要重新引入自己的库 `src/sass/common/_font.scss`
`src => images` 公共图片存放
`src => js` js/vue
`src => lib` 公司内部组件(公司组件库开源后可删掉)
`src => sass` sass文件 一个页面对应一个sass文件
`src => view` 页面文件 一个页面对应一个html文件
```
> 项目采用vue单页面应用(SPA)开发
- 所有页面入口文件在 `src/js/conf/${对应页面文件名 => home}``index.js` 入口文件
- 对应的sass文件则在 `src/sass/conf/${对应页面文件名 => home}/index.scss`
- 对应的html文件则在 `src/view/${对应页面文件名 => home}/index.html`
```
公共模块及util `src/js/module`
`components` => 内部项目公共组件
`download` => 下载组件
`echarts` => 图表组件
`filter` => 过滤器和vue管道
`i18n` => 国际化
`io` => io请求封装 基于axios
`mixin` => vue mixin 公共部分 用于disabled操作
`permissions` => 权限操作
`util` => 工具
### 开发环境搭建
@ -133,6 +84,56 @@ npm install node-sass --unsafe-perm //单独安装node-sass依赖
```
### 项目目录结构
`build` 打包及开发环境项目的一些webpack配置
`node_modules` 开发环境node依赖包
`src` 项目所需文件
`src => combo` 项目第三方资源本地化 `npm run combo`具体查看`build/combo.js`
`src => font` 字体图标库可访问 https://www.iconfont.cn 进行添加 注意:字体库用的自己的 二次开发需要重新引入自己的库 `src/sass/common/_font.scss`
`src => images` 公共图片存放
`src => js` js/vue
`src => lib` 公司内部组件(公司组件库开源后可删掉)
`src => sass` sass文件 一个页面对应一个sass文件
`src => view` 页面文件 一个页面对应一个html文件
```
> 项目采用vue单页面应用(SPA)开发
- 所有页面入口文件在 `src/js/conf/${对应页面文件名 => home}``index.js` 入口文件
- 对应的sass文件则在 `src/sass/conf/${对应页面文件名 => home}/index.scss`
- 对应的html文件则在 `src/view/${对应页面文件名 => home}/index.html`
```
公共模块及util `src/js/module`
`components` => 内部项目公共组件
`download` => 下载组件
`echarts` => 图表组件
`filter` => 过滤器和vue管道
`i18n` => 国际化
`io` => io请求封装 基于axios
`mixin` => vue mixin 公共部分 用于disabled操作
`permissions` => 权限操作
`util` => 工具
### 系统功能模块
首页 => `http://localhost:8888/#/home`

2
docs/zh_CN/后端部署文档.md

@ -144,7 +144,7 @@ install.sh : 一键部署脚本
### 2.3 系统常用启停服务
### 2.3 系统常用启停服务(服务用途请具体参见《系统架构设计》小节)
* 一键停止集群所有服务

Loading…
Cancel
Save