完善文档

This commit is contained in:
暮光:城中城
2020-08-23 12:29:56 +08:00
parent 44ebfbf554
commit 96079c8fa1
7 changed files with 41 additions and 92 deletions

View File

@@ -4,7 +4,7 @@
1、命令行要进入这个文件夹才能执行命令
zyplayer-doc/zyplayer-doc-ui/manage-ui
zyplayer-doc/zyplayer-doc-ui/console-ui
2、增加host否则run不起来
@@ -20,7 +20,7 @@ zyplayer-doc-ui/manage-ui/src/common/config/apimix.js
2、这里可以配置启动后访问的地址建议不改
zyplayer-doc-ui/manage-ui/webpack.config.js
zyplayer-doc-ui/console-ui/webpack.config.js
## 环境要求

View File

@@ -1,28 +1,47 @@
# zyplayer-doc-db项目的UI
## 常见问题
1、命令行要进入这个文件夹才能执行命令
zyplayer-doc/zyplayer-doc-ui/db-ui
2、修改host否则run不起来
在文件 C:\Windows\System32\drivers\etc\hosts 末尾增加:
127.0.0.1 local.zyplayer.com
## 配置文件
配置开发环境和线上环境的请求域名地址:
开发环境:.env.development
线上环境:.env.production
## 环境要求
`Node >= 6`
## 开始
``` bash
# 执行下面的命令初始化
yarn
npm install
```
## 开发环境
``` bash
# 执行下面的命令后即可到 localhost:8010 看到页面
# 执行下面的命令后即可到启动前端工程
npm run dev
```
## 打包
``` bash
# 开发完成后执行打包命令然后复制dist目录里的文件到zyplayer-doc-manage项目的webjars目录下即可
# 打包前记得修改zyplayer-doc-ui/manage-ui/src/common/config/apimix.js里的HOST接口地址
npm run build
# 开发完成后执行打包命令然后复制dist目录里的文件到zyplayer-doc-db/resources目录下
# 复制完成后记得修改index.html为doc-db.html
# todo是否可以直接打包为doc-db.html不用手动改名字
# todo是否可以直接打包到zyplayer-doc-db/resources文件夹下难得复制
```

View File

@@ -3,6 +3,7 @@ zyplayer-doc-wiki项目的UI使用此项目构建开发起来爽得很
但是,才发第一版,又他喵得重构一次~
之前从jQuery换到element以为是结局了爽到吐结果又被这个迷住了前端真是让人高潮个不停啊
但是,好东西怎么放过呢!
---来自一个前端新手的BB
## 常见问题
@@ -10,7 +11,7 @@ zyplayer-doc-wiki项目的UI使用此项目构建开发起来爽得很
zyplayer-doc/zyplayer-doc-ui/wiki-ui
2、增加host否则run不起来
2、修改host否则run不起来
在文件 C:\Windows\System32\drivers\etc\hosts 末尾增加:
@@ -18,37 +19,34 @@ zyplayer-doc/zyplayer-doc-ui/wiki-ui
## 配置文件
1、这里可以配置接口请求域名可使用本地、线上测试通过后就会打包到zyplayer-doc-wiki项目里面使用
zyplayer-doc-ui/wiki-ui/src/common/config/apimix.js
2、这里可以配置启动后访问的地址建议不改
zyplayer-doc-ui/wiki-ui/webpack.config.js
配置开发环境和线上环境的请求域名地址:
开发环境:.env.development
线上环境:.env.production
## 环境要求
`Node >= 6`
## 开始
``` bash
# 执行下面的命令初始化
yarn
npm install
```
## 开发环境
``` bash
# 执行下面的命令后即可到 localhost:8010 看到页面
# 执行下面的命令后即可到启动前端工程
npm run dev
```
## 打包
``` bash
# 开发完成后执行打包命令然后复制dist目录里的文件到zyplayer-doc-wiki项目的webjars目录下即可
# 打包前记得修改zyplayer-doc-ui/wiki-ui/src/common/config/apimix.js里的HOST接口地址
npm run build
# 开发完成后执行打包命令然后复制dist目录里的文件到zyplayer-doc-wiki/resources目录下
# 复制完成后记得修改index.html为doc-wiki.html
# todo是否可以直接打包为doc-wiki.html不用手动改名字
# todo是否可以直接打包到zyplayer-doc-wiki/resources文件夹下难得复制
```