Commit c60e4f41801f698ef418ca2474ecec26ed09928a
1 parent
8d669af7
docs: update README
Showing
4 changed files
with
62 additions
and
87 deletions
README.md
| @@ -4,7 +4,7 @@ | @@ -4,7 +4,7 @@ | ||
| 4 | 鲁班 H5 | 4 | 鲁班 H5 |
| 5 | </h2> | 5 | </h2> |
| 6 | <p align="center"> | 6 | <p align="center"> |
| 7 | -基于Vue开发，通过拖拽的形式，生成移动页面 | 7 | +可视化搭建，拖拽生成移动端页面 |
| 8 | </p> | 8 | </p> |
| 9 | <p align="center"> | 9 | <p align="center"> |
| 10 | Mobile Page Builder&Generator with Drag&Drop | 10 | Mobile Page Builder&Generator with Drag&Drop |
| @@ -19,9 +19,8 @@ Mobile Page Builder&Generator with Drag&Drop | @@ -19,9 +19,8 @@ Mobile Page Builder&Generator with Drag&Drop | ||
| 19 | [](https://gitee.com/ly525/luban-h5.git) | 19 | [](https://gitee.com/ly525/luban-h5.git) |
| 20 | 20 | ||
| 21 | ## 快速体验 | 21 | ## 快速体验 |
| 22 | -> 以下三种方式，任选其中一种即可 | ||
| 23 | 22 | ||
| 24 | -#### 一、一键脚本 | 23 | +#### 一键脚本 |
| 25 | ```bash | 24 | ```bash |
| 26 | git clone https://github.com/ly525/luban-h5 && cd luban-h5 | 25 | git clone https://github.com/ly525/luban-h5 && cd luban-h5 |
| 27 | # 安装依赖，构建前后端（安装依赖会耗时略长，请耐心等待） | 26 | # 安装依赖，构建前后端（安装依赖会耗时略长，请耐心等待） |
| @@ -38,44 +37,6 @@ git clone https://github.com/ly525/luban-h5 && cd luban-h5 | @@ -38,44 +37,6 @@ git clone https://github.com/ly525/luban-h5 && cd luban-h5 | ||
| 38 | - 如果遇到接口 403 问题，请参照 [`快速开始`](https://ly525.github.io/luban-h5/zh/getting-started/quick-start.html) 章节，搜索关键字：403 即可 | 37 | - 如果遇到接口 403 问题，请参照 [`快速开始`](https://ly525.github.io/luban-h5/zh/getting-started/quick-start.html) 章节，搜索关键字：403 即可 |
| 39 | 38 | ||
| 40 | 39 | ||
| 41 | -#### 二、本地安装了 Node、Yarn | ||
| 42 | -```bash | ||
| 43 | -git clone https://github.com/ly525/luban-h5 | ||
| 44 | -cd luban-h5 # 项目根目录 | ||
| 45 | - | ||
| 46 | -# 后端 | ||
| 47 | -cd back-end/h5-api && yarn && yarn dev | ||
| 48 | - | ||
| 49 | -# 前端 | ||
| 50 | -# 新开一个终端，在项目根目录执行如下命令 | ||
| 51 | -cd front-end/h5 && yarn && yarn build:engine && yarn dev | ||
| 52 | -``` | ||
| 53 | -- 按照提示，在浏览器中访问终端中提示的 URL 即可 | ||
| 54 | -- 更多细节，请参照 [鲁班H5-在线文档](https://ly525.github.io/luban-h5/zh/) 的 [`快速开始`](https://ly525.github.io/luban-h5/zh/getting-started/quick-start.html) 章节，进行配置即可 | ||
| 55 | - | ||
| 56 | - | ||
| 57 | -#### 二、熟悉 Docker | ||
| 58 | -> 使用官方提供的 [***一键安装脚本***](https://raw.githubusercontent.com/ly525/luban-h5/dev/deploy/ubuntu-install.sh)，简化安装步骤，在本地通过使用 `Docker+Ubuntu 镜像`，即可`快速安装+体验` 鲁班H5 | ||
| 59 | - | ||
| 60 | -> [快速体验-完整文档](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)，简而言之： | ||
| 61 | - | ||
| 62 | -```shell | ||
| 63 | -docker pull ubuntu | ||
| 64 | -docker run -it -p 1234:80 -p 1235:1337 -v `pwd`:/app ubuntu | ||
| 65 | -# 使用清华大学 Ubuntu 软件镜像 | ||
| 66 | -sed -i 's/archive.ubuntu.com/mirrors.tuna.tsinghua.edu.cn/g' /etc/apt/sources.list | ||
| 67 | -apt update && apt install -y wget git | ||
| 68 | -wget -qO- https://raw.githubusercontent.com/ly525/luban-h5/dev/deploy/ubuntu-install.sh | bash | ||
| 69 | - | ||
| 70 | -# 安装完成之后 | ||
| 71 | -# 1. visit ：http://localhost:1234/admin，自定义配置账号密码，登录即可 | ||
| 72 | -# 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 | ||
| 73 | - | ||
| 74 | -# 2. 鲁班前端 | ||
| 75 | -# 2.1 宿主机访问 「鲁班前端」：localhost:1234, 即可看到鲁班的前端 | ||
| 76 | -``` | ||
| 77 | - | ||
| 78 | - | ||
| 79 | 40 | ||
| 80 | 41 | ||
| 81 | ### 🔗Links/相关链接 | 42 | ### 🔗Links/相关链接 |
| @@ -165,12 +126,6 @@ wget -qO- https://raw.githubusercontent.com/ly525/luban-h5/dev/deploy/ubuntu-ins | @@ -165,12 +126,6 @@ wget -qO- https://raw.githubusercontent.com/ly525/luban-h5/dev/deploy/ubuntu-ins | ||
| 165 | - [x] 在线预览 | 126 | - [x] 在线预览 |
| 166 | - [x] 二维码预览 | 127 | - [x] 二维码预览 |
| 167 | 128 | ||
| 168 | - | ||
| 169 | -### 更多说明 | ||
| 170 | -#### 前端组件说明 | ||
| 171 | -1. `lbp-` 全称为 `lu-ban-plugin-`, 意思为 `鲁班H5的插件`，位置：`front-end/h5/src/components/plugins` | ||
| 172 | - | ||
| 173 | - | ||
| 174 | #### 技术栈（当前） | 129 | #### 技术栈（当前） |
| 175 | 1. 前端：[Vue.js](https://vuejs.org/v2/guide/) | 130 | 1. 前端：[Vue.js](https://vuejs.org/v2/guide/) |
| 176 | 2. 后端：[Strapi](https://strapi.io/) | 131 | 2. 后端：[Strapi](https://strapi.io/) |
docs/zh/README.md
| @@ -21,47 +21,22 @@ footer: GPL 3.0 Licensed | Copyright © 2019-present | @@ -21,47 +21,22 @@ footer: GPL 3.0 Licensed | Copyright © 2019-present | ||
| 21 | [](https://gitee.com/ly525/luban-h5.git) | 21 | [](https://gitee.com/ly525/luban-h5.git) |
| 22 | 22 | ||
| 23 | ## 快速体验 | 23 | ## 快速体验 |
| 24 | -> 以下两种方式，任选其中一种即可 | ||
| 25 | 24 | ||
| 26 | -#### 一、本地安装了 Node、Yarn | 25 | +#### 一键脚本 |
| 27 | ```bash | 26 | ```bash |
| 28 | -git clone https://github.com/ly525/luban-h5 | ||
| 29 | -cd luban-h5 # 项目根目录 | 27 | +git clone https://github.com/ly525/luban-h5 && cd luban-h5 |
| 28 | +# 安装依赖，构建前后端（安装依赖会耗时略长，请耐心等待） | ||
| 29 | +./luban-h5.sh init | ||
| 30 | 30 | ||
| 31 | -# 后端 | ||
| 32 | -cd back-end/h5-api && yarn && yarn dev | 31 | +# 启动项目访问 http://localhost:1337 即可 |
| 32 | +./luban-h5.sh start | ||
| 33 | 33 | ||
| 34 | -# 前端 | ||
| 35 | -# 新开一个终端，在项目根目录执行如下命令 | ||
| 36 | -cd front-end/h5 && yarn && yarn build:engine && yarn dev | 34 | +# ./luban-h5.sh stop |
| 37 | ``` | 35 | ``` |
| 38 | -- 按照提示，在浏览器中访问终端中提示的 URL 即可 | ||
| 39 | -- 更多细节，请参照 [鲁班H5-在线文档](https://ly525.github.io/luban-h5/zh/) 的 [`快速开始`](https://ly525.github.io/luban-h5/zh/getting-started/quick-start.html) 章节，进行配置即可 | ||
| 40 | - | ||
| 41 | - | ||
| 42 | -#### 二、熟悉 Docker | ||
| 43 | -> 使用官方提供的 [***一键安装脚本***](https://raw.githubusercontent.com/ly525/luban-h5/dev/deploy/ubuntu-install.sh)，简化安装步骤，在本地通过使用 `Docker+Ubuntu 镜像`，即可`快速安装+体验` 鲁班H5 | ||
| 44 | - | ||
| 45 | -> [快速体验-完整文档](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)，简而言之： | ||
| 46 | - | ||
| 47 | -```shell | ||
| 48 | -docker pull ubuntu | ||
| 49 | -docker run -it -p 1234:80 -p 1235:1337 -v `pwd`:/app ubuntu | ||
| 50 | -# 使用清华大学 Ubuntu 软件镜像 | ||
| 51 | -sed -i 's/archive.ubuntu.com/mirrors.tuna.tsinghua.edu.cn/g' /etc/apt/sources.list | ||
| 52 | -apt update && apt install -y wget git | ||
| 53 | -wget -qO- https://raw.githubusercontent.com/ly525/luban-h5/dev/deploy/ubuntu-install.sh | bash | ||
| 54 | - | ||
| 55 | -# 安装完成之后 | ||
| 56 | -# 1. visit ：http://localhost:1234/admin，自定义配置账号密码，登录即可 | ||
| 57 | -# 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 | ||
| 58 | - | ||
| 59 | -# 2. 鲁班前端 | ||
| 60 | -# 2.1 宿主机访问 「鲁班前端」：localhost:1234, 即可看到鲁班的前端 | ||
| 61 | -``` | ||
| 62 | - | ||
| 63 | 36 | ||
| 37 | +- 更多细节，请参照 [鲁班H5-在线文档](https://ly525.github.io/luban-h5/zh/) 的 [`快速开始`](https://ly525.github.io/luban-h5/zh/getting-started/quick-start.html) 章节，进行配置即可 | ||
| 64 | 38 | ||
| 39 | +- 如果遇到接口 403 问题，请参照 [`快速开始`](https://ly525.github.io/luban-h5/zh/getting-started/quick-start.html) 章节，搜索关键字：403 即可 | ||
| 65 | 40 | ||
| 66 | ### 🔗Links/相关链接 | 41 | ### 🔗Links/相关链接 |
| 67 | | 源码 | 文档 | 教程 | 社区 | | 42 | | 源码 | 文档 | 教程 | 社区 | |
| @@ -106,9 +81,9 @@ wget -qO- https://raw.githubusercontent.com/ly525/luban-h5/dev/deploy/ubuntu-ins | @@ -106,9 +81,9 @@ wget -qO- https://raw.githubusercontent.com/ly525/luban-h5/dev/deploy/ubuntu-ins | ||
| 106 | 81 | ||
| 107 | ### 交流群 | 82 | ### 交流群 |
| 108 | 83 | ||
| 109 | -| 钉钉群 | 微信公众号 | 微信 | | 84 | +| 微信群<推荐> | 微信公众号 | 钉钉群 | |
| 110 | |---|---|---| | 85 | |---|---|---| |
| 111 | -| <img src="https://user-images.githubusercontent.com/12668546/61447488-a379f700-a983-11e9-9956-139352a2585d.png" width="200" />| <img src="https://user-images.githubusercontent.com/12668546/65471913-ab827580-dea3-11e9-919c-870c9605c60f.png" width="200" /> | <img src="https://user-images.githubusercontent.com/12668546/66585418-5cce1e80-ebb9-11e9-91c0-56f658f09e27.png" width="200" /> <br />请备注：鲁班H5交流| | 86 | +| <img src="https://user-images.githubusercontent.com/12668546/66585418-5cce1e80-ebb9-11e9-91c0-56f658f09e27.png" width="200" /> <br />请备注：鲁班H5交流| <img src="https://user-images.githubusercontent.com/12668546/65471913-ab827580-dea3-11e9-919c-870c9605c60f.png" width="200" /> | <img src="https://user-images.githubusercontent.com/12668546/61447488-a379f700-a983-11e9-9956-139352a2585d.png" width="200" /> | |
| 112 | 87 | ||
| 113 | 88 | ||
| 114 | #### 技术栈（当前） | 89 | #### 技术栈（当前） |
docs/zh/getting-started/introduction.md
| @@ -20,10 +20,6 @@ | @@ -20,10 +20,6 @@ | ||
| 20 | ### 鲁班H5是什么？ | 20 | ### 鲁班H5是什么？ |
| 21 | 鲁班H5是基于Vue2.0开发的，通过拖拽的形式，生成页面的工具，类似[易企秀](http://www.eqxiu.com/)、[百度 H5](https://h5.baidu.com) 等工具 | 21 | 鲁班H5是基于Vue2.0开发的，通过拖拽的形式，生成页面的工具，类似[易企秀](http://www.eqxiu.com/)、[百度 H5](https://h5.baidu.com) 等工具 |
| 22 | 22 | ||
| 23 | - | ||
| 24 | -### Screenshots | ||
| 25 | -> [主页](https://h5.luban-h5.com) | ||
| 26 | - | ||
| 27 |  | 23 |  |
| 28 | 24 | ||
| 29 | --- | 25 | --- |
docs/zh/getting-started/quick-start.md
| @@ -3,7 +3,31 @@ | @@ -3,7 +3,31 @@ | ||
| 3 | - 如果您已经熟悉并已经安装了 `Node`、`Yarn`，可以直接参照下面的命令，快速上手 | 3 | - 如果您已经熟悉并已经安装了 `Node`、`Yarn`，可以直接参照下面的命令，快速上手 |
| 4 | - 如果您不熟悉，请阅读下面的详细教程 | 4 | - 如果您不熟悉，请阅读下面的详细教程 |
| 5 | 5 | ||
| 6 | +## 快速体验 | ||
| 7 | +> 以下三种方式，任选其中一种即可 | ||
| 8 | + | ||
| 9 | +#### 一、一键脚本（推荐！） | ||
| 10 | +```bash | ||
| 11 | +git clone https://github.com/ly525/luban-h5 && cd luban-h5 | ||
| 12 | +# 安装依赖，构建前后端（安装依赖会耗时略长，请耐心等待） | ||
| 13 | +./luban-h5.sh init | ||
| 14 | + | ||
| 15 | +# 启动项目访问 http://localhost:1337 即可 | ||
| 16 | +./luban-h5.sh start | ||
| 17 | + | ||
| 18 | +# ./luban-h5.sh stop | ||
| 19 | +``` | ||
| 20 | + | ||
| 21 | +- 更多细节，请参照 [鲁班H5-在线文档](https://ly525.github.io/luban-h5/zh/) 的 [`快速开始`](https://ly525.github.io/luban-h5/zh/getting-started/quick-start.html) 章节，进行配置即可 | ||
| 22 | + | ||
| 23 | +- 如果遇到接口 403 问题，请参照 [`快速开始`](https://ly525.github.io/luban-h5/zh/getting-started/quick-start.html) 章节，搜索关键字：403 即可 | ||
| 24 | + | ||
| 25 | + | ||
| 26 | +#### 二、本地安装了 Node、Yarn | ||
| 6 | ```bash | 27 | ```bash |
| 28 | +git clone https://github.com/ly525/luban-h5 | ||
| 29 | +cd luban-h5 # 项目根目录 | ||
| 30 | + | ||
| 7 | # 后端 | 31 | # 后端 |
| 8 | cd back-end/h5-api && yarn && yarn dev | 32 | cd back-end/h5-api && yarn && yarn dev |
| 9 | 33 | ||
| @@ -11,6 +35,31 @@ cd back-end/h5-api && yarn && yarn dev | @@ -11,6 +35,31 @@ cd back-end/h5-api && yarn && yarn dev | ||
| 11 | # 新开一个终端，在项目根目录执行如下命令 | 35 | # 新开一个终端，在项目根目录执行如下命令 |
| 12 | cd front-end/h5 && yarn && yarn build:engine && yarn dev | 36 | cd front-end/h5 && yarn && yarn build:engine && yarn dev |
| 13 | ``` | 37 | ``` |
| 38 | +- 按照提示，在浏览器中访问终端中提示的 URL 即可 | ||
| 39 | +- 更多细节，请参照 [鲁班H5-在线文档](https://ly525.github.io/luban-h5/zh/) 的 [`快速开始`](https://ly525.github.io/luban-h5/zh/getting-started/quick-start.html) 章节，进行配置即可 | ||
| 40 | + | ||
| 41 | + | ||
| 42 | +#### 三、熟悉 Docker（迭代中，不推荐使用，后期会推出docker image） | ||
| 43 | +> 使用官方提供的 [***一键安装脚本***](https://raw.githubusercontent.com/ly525/luban-h5/dev/deploy/ubuntu-install.sh)，简化安装步骤，在本地通过使用 `Docker+Ubuntu 镜像`，即可`快速安装+体验` 鲁班H5 | ||
| 44 | + | ||
| 45 | +> [快速体验-完整文档](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)，简而言之： | ||
| 46 | + | ||
| 47 | +```shell | ||
| 48 | +docker pull ubuntu | ||
| 49 | +docker run -it -p 1234:80 -p 1235:1337 -v `pwd`:/app ubuntu | ||
| 50 | +# 使用清华大学 Ubuntu 软件镜像 | ||
| 51 | +sed -i 's/archive.ubuntu.com/mirrors.tuna.tsinghua.edu.cn/g' /etc/apt/sources.list | ||
| 52 | +apt update && apt install -y wget git | ||
| 53 | +wget -qO- https://raw.githubusercontent.com/ly525/luban-h5/dev/deploy/ubuntu-install.sh | bash | ||
| 54 | + | ||
| 55 | +# 安装完成之后 | ||
| 56 | +# 1. visit ：http://localhost:1234/admin，自定义配置账号密码，登录即可 | ||
| 57 | +# 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 | ||
| 58 | + | ||
| 59 | +# 2. 鲁班前端 | ||
| 60 | +# 2.1 宿主机访问 「鲁班前端」：localhost:1234, 即可看到鲁班的前端 | ||
| 61 | +``` | ||
| 62 | + | ||
| 14 | 63 | ||
| 15 | # 常见问题 | 64 | # 常见问题 |
| 16 | > 这部分一般是按照下面的教程运行之后，仍然可能会遇到的问题。比较适合粗心、文档只看了一半、比较着急的同学 | 65 | > 这部分一般是按照下面的教程运行之后，仍然可能会遇到的问题。比较适合粗心、文档只看了一半、比较着急的同学 |