add quick start docs

ly525
1 parent 2e123b64
Showing 2 changed files with 72 additions and 3 deletions
README.md
deploy/ubuntu-install.sh
@@ -16,6 +16,30 @@ Mobile Page Builder&amp;Generator with Drag&amp;Drop
 </p>
+
+### 快速体验
+> * 使用官方提供的 [***一键安装脚本***](https://raw.githubusercontent.com/ly525/luban-h5/dev/deploy/ubuntu-install.sh)，简化安装步骤，在本地通过使用 Docker+Ubuntu 镜像，即可快速安装+体验 鲁班H5
+
+> * [快速体验-完整文档](https://github.com/ly525/luban-h5/wiki/Quick-Start(%E5%BF%AB%E9%80%9F%E4%B8%8A%E6%89%8B%E7%AF%87)%EF%BC%9ADocker-Ubuntu-Image-for-Quick-Local-Dev)
+
+> * 简而言之：
+
+```bash
+docker pull ubuntu
+docker run -it -p 1234:80 -p 1235:1337  -v `pwd`:/app ubuntu
+wget -qO- https://raw.githubusercontent.com/ly525/luban-h5/dev/deploy/ubuntu-install.sh | bash
+
+# 安装完成之后
+# 1. visit ：http://localhost:1234/admin，自定义配置账号密码，登录即可
+# 1.2 配置相关权限，文档参见：https://ly525.github.io/luban-h5/zh/getting-started/quick-start.html#%E5%90%8E%E7%AB%AF%E7%8E%AF%E5%A2%83%E6%90%AD%E5%BB%BA
+
+# 2. 鲁班前端
+# 2.1 宿主机访问 「鲁班前端」：localhost:1234/main, 即可看到鲁班的前端
+```
+
+<a href="https://terminalizer.com/view/b1432a8c2508"><img width="70%" alt="Gitter" src="https://user-images.githubusercontent.com/12668546/69896337-55d1ba00-1379-11ea-8a56-5122930d2501.png"></a>
+
+
 ### 🔗Links/相关链接
 - 文档
     * [📖中文在线文档](https://ly525.github.io/luban-h5/zh/)
 #/usr/bin/env
+
+###
+# @Author: ly525
+ # @Date: 2019-11-30 13:24:57
+ # @LastEditors: ly525
+ # @LastEditTime: 2019-11-30 13:30:07
+ # @FilePath: /luban-h5/deploy/ubuntu-install.sh
+ # @Github: https://github.com/ly525/luban-h5
+ # @Description:
+ ## #!en: One-Click Setup Script to Install Luban-H5 on Ubuntu 18.04
+ ## #!zh: 鲁班H5 Ubuntu18.04 一键安装脚本
+ # @Copyright 2018 - 2019 luban-h5. All Rights Reserved
+ ###
+
+## !en:
+######################################################
+#    One-Click Setup Script to Install Luban-H5 on Ubuntu 18.04
+######################################################
+
+
+######################################################
+#         Step1: Download && Run the Script
+# docker pull ubuntu
+# docker run -it -p 1234:80 -p 1235:1337  -v `pwd`:/app ubuntu
+# wget -qO- https://raw.githubusercontent.com/ly525/luban-h5/dev/deploy/ubuntu-install.sh | bash
+######################################################
+
+######################################################
+#          Step2: After the Script Runs
+# 1. Luban H5 Admin
+# 1.1 visit on your host machine：http://localhost:1234/admin,   custom the username and password, then login the admin
+# 1.2 config the permission,see more here：https://ly525.github.io/luban-h5/zh/getting-started/quick-start.html#%E5%90%8E%E7%AB%AF%E7%8E%AF%E5%A2%83%E6%90%AD%E5%BB%BA
+
+# 2. Luban H5 Front-End
+# 2.1visit on your host machine ：http://localhost:1234/main, enjoy it!
+######################################################
+
+######################################################
+#           Feedback
+
+# GitHub：https://github.com/ly525/luban-h5/issues
+######################################################
+
+
+## #!zh
 ######################################################
 #           [鲁班H5] Ubuntu18.04 一键安装脚本
 ######################################################
@@ -84,7 +129,7 @@ function set_apt_mirror {
   # 或替换为中科大镜像：https://lug.ustc.edu.cn/wiki/mirrors/help/ubuntu
   # sudo sed -i 's/archive.ubuntu.com/mirrors.ustc.edu.cn/g' /etc/apt/sources.list
   # sudo sed -i 's/archive.ubuntu.com/mirrors.tuna.tsinghua.edu.cn/g' /etc/apt/sources.list
-  # 
+  #
   sed -i 's/archive.ubuntu.com/mirrors.tuna.tsinghua.edu.cn/g' /etc/apt/sources.list
   apt update
@@ -154,7 +199,7 @@ function install_yarn {
     curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -
     echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list
     # https://yarnpkg.com/en/docs/install#debian-stable
-    apt-get remove -y cmdtest 
+    apt-get remove -y cmdtest
     apt-get update
     apt-get install -y yarn
     success yarn
@@ -312,7 +357,7 @@ function install_luban-h5 {
     cd -
     # 鲁班后端
-    cd luban-h5/back-end/h5-api/ 
+    cd luban-h5/back-end/h5-api/
     yarn
     yarn build # build strapi admin
     pm2 start server.js