docs(quick-start): update engine:build to build:engine

ly525
1 parent 1f549908
Showing 3 changed files with 9 additions and 11 deletions
deploy/ubuntu-install.sh
docs/en/getting-started/quick-start.md
docs/zh/getting-started/quick-start.md
@@ -5,7 +5,7 @@
  # @Author: ly525
  # @Date: 2019-11-30 13:24:57
  # @LastEditors  : ly525
- # @LastEditTime : 2020-01-05 16:22:19
+ # @LastEditTime : 2020-01-05 21:39:42
  # @FilePath: /luban-h5/deploy/ubuntu-install.sh
  # @Github: https://github.com/ly525/luban-h5
  # @Description:
@@ -331,14 +331,12 @@ function install_luban-h5 {
     git clone https://github.com/ly525/luban-h5
  
     # 鲁班前端
-    cd luban-h5/front-end/h5 && yarn && yarn build && yarn engine:build
+    cd luban-h5/front-end/h5 && yarn && yarn build # build editor and preview engine
  
     cd -
  
     # 鲁班后端
-    cd luban-h5/back-end/h5-api/
-    yarn
-    yarn build # build strapi admin
+    cd luban-h5/back-end/h5-api/ && yarn && yarn build # build strapi admin
     pm2 start server.js
     pwd
     success luban-h5
@@ -10,7 +10,7 @@ cd back-end/h5-api &amp;&amp; yarn &amp;&amp; yarn dev
  
 # open a new terminal and goto the project root path
  
-cd front-end/h5 && yarn && yarn engine:build && yarn dev
+cd front-end/h5 && yarn && yarn build:engine && yarn dev
 ```
  
 # Overview
@@ -82,7 +82,7 @@ error TypeError: ctx.render is not a function
 ### 1. quick start
 ```bash
 # by default, the current path is the root path of luban-h5
-cd front-end/h5 && yarn && yarn engine:build && yarn dev
+cd front-end/h5 && yarn && yarn build:engine && yarn dev
  
 # more commands
 # please refer to project/front-end/h5/package.json
@@ -102,7 +102,7 @@ previewOne: async (ctx) =&gt; {
 ```
  
 #### How to build preview engine
-1. cd `front-end/h5`, run `yarn engine:build`
+1. cd `front-end/h5`, run `yarn build:engine`
 2. after build finished, an folder named `engine-assets`  is auto generated at `back-end/h5-api/public`
 3. `preview.vue` is preview modal, the mobile div is an iframe which a wrapper for builded `engine-entry`, learn more about engine here: `luban-h5/front-end/h5/vue.config.js`
  
@@ -11,7 +11,7 @@
 cd back-end/h5-api && yarn && yarn dev
  
 # 新开一个终端，回到项目根目录
-cd front-end/h5 && yarn && yarn engine:build && yarn dev
+cd front-end/h5 && yarn && yarn build:engine && yarn dev
 ```
  
 # 常见问题
@@ -120,7 +120,7 @@ error TypeError: ctx.render is not a function
  
 ```bash
 # 默认当前位置目录为 luban-h5 项目的根目录
-cd front-end/h5 && yarn && yarn engine:build && yarn dev
+cd front-end/h5 && yarn && yarn build:engine && yarn dev
  
 # 更多命令
 请参见 project/front-end/h5/package.json
@@ -139,7 +139,7 @@ previewOne: async (ctx) =&gt; {
 },
 ```
 #### 如何构建
-1. 在`front-end/h5`目录下，运行：`yarn engine:build`
+1. 在`front-end/h5`目录下，运行：`yarn build:engine`
 2. 构建完成之后,后端的`h5-api/public`里面会多一个文件夹 `engine-assets`
 3. 打开的预览窗口`preview.vue`, 里面的预览部分对应的其实是一个 iframe，可以看看对应的源码
   也就是说，这个预览其实依赖后端的渲染引擎，比如 ejs 或者 jade 这种模板引擎，所以参照这里：`luban-h5/front-end/h5/vue.config.js` `engineOutputDir` 变量，preview engine 构建完成，会生成到后端的 `back-end/h5-api/public/engine-assets` 目录