徐烜 / bsth-ebus-h5_editor · Commits

Commit b782ec9e59709000da53faeef456f81e67b2e63c

Authored by ly525
1 parent e492406a

chore: update README

Inline Side-by-side
Showing 2 changed files with 28 additions and 12 deletions
README.en.md
  View file @b782ec9
@@ -16,17 +16,20 @@ @@ -16,17 +16,20 @@
16 > in short 16 > in short
17 17
18 ```shell 18 ```shell
19 -docker pull ubuntu  
20 -docker run -it -p 1234:80 -p 1235:1337 -v `pwd`:/app ubuntu  
21 -apt update && apt install -y wget git  
22 -wget -qO- https://raw.githubusercontent.com/ly525/luban-h5/dev/deploy/ubuntu-install.sh | bash 19 +git clone https://github.com/ly525/luban-h5 && cd luban-h5
  20 +# install dependencies && build front-end && build back-end
  21 +./luban-h5.sh init
  22 +
  23 +./luban-h5.sh start
  24 +
  25 +# ./luban-h5.sh stop
23 26
24 # after the installation finished 27 # after the installation finished
25 -# 1. visit ：http://localhost:1235/admin, add your admin account 28 +# 1. visit ：http://localhost:1337/admin, create your admin account
26 # 1.2 config the api permissions, see more here：https://ly525.github.io/luban-h5/en/getting-started/quick-start.html#_2-something-important 29 # 1.2 config the api permissions, see more here：https://ly525.github.io/luban-h5/en/getting-started/quick-start.html#_2-something-important
27 30
28 # 2. front-end 31 # 2. front-end
29 -# 2.1 visit https://localhost:1235 to get the front-end of luban-h5 32 +# 2.1 visit https://localhost:1337 to get the front-end of luban-h5
30 ``` 33 ```
31 34
32 ## Links 35 ## Links
README.md
  View file @b782ec9
@@ -46,7 +46,7 @@ Mobile Page Builder&Generator with Drag&Drop @@ -46,7 +46,7 @@ Mobile Page Builder&Generator with Drag&Drop
46 | ------ | -------- | ------ | ------ | 46 | ------ | -------- | ------ | ------ |
47 | [GitHub](https://github.com/ly525/luban-h5) | [中文文档](https://ly525.github.io/luban-h5/zh/) | [视频-快速开始(哔哩哔哩)](https://space.bilibili.com/121039466/channel/detail?cid=94066) | [论坛/社区(官方推荐)](https://github.com/ly525/luban-h5/discussions) 47 | [GitHub](https://github.com/ly525/luban-h5) | [中文文档](https://ly525.github.io/luban-h5/zh/) | [视频-快速开始(哔哩哔哩)](https://space.bilibili.com/121039466/channel/detail?cid=94066) | [论坛/社区(官方推荐)](https://github.com/ly525/luban-h5/discussions)
48 | [Gitee (国内镜像)](https://gitee.com/ly525/luban-h5) | [English Docs](https://ly525.github.io/luban-h5/en/getting-started/introduction.html) | 自定义组件教程(WIP) | [Gitter](https://gitter.im/luban-h5/community) | 48 | [Gitee (国内镜像)](https://gitee.com/ly525/luban-h5) | [English Docs](https://ly525.github.io/luban-h5/en/getting-started/introduction.html) | 自定义组件教程(WIP) | [Gitter](https://gitter.im/luban-h5/community) |
49 -| | [README(En)](./README.en.md) | [核心实现原理](https://juejin.im/post/5d6df27a6fb9a06b2d77eef9) | [中文社区/论坛(腾讯吐个槽)](https://support.qq.com/product/93432) | 49 +| | [README(En)](./README.en.md) | [核心实现原理](https://juejin.im/post/5d6df27a6fb9a06b2d77eef9) | [中文社区/论坛(腾讯吐个槽)](https://support.qq.com/product/93432) |
50 50
51 51
52 ### 🔗生态 52 ### 🔗生态
@@ -57,9 +57,10 @@ Mobile Page Builder&Generator with Drag&Drop @@ -57,9 +57,10 @@ Mobile Page Builder&Generator with Drag&Drop
57 | [SpringBoot2-Mybatis-plus](https://github.com/luban-h5/springboot2-mybatis-plus-api-for-luban) | | | 视频教程(WIP) | | 57 | [SpringBoot2-Mybatis-plus](https://github.com/luban-h5/springboot2-mybatis-plus-api-for-luban) | | | 视频教程(WIP) | |
58 58
59 59
60 -## 快速上手 60 +## 快速体验
  61 +> 以下方式，任选其中一种即可
61 62
62 -#### 一键脚本 63 +#### 一、一键脚本（推荐！）
63 ```bash 64 ```bash
64 git clone https://github.com/ly525/luban-h5 && cd luban-h5 65 git clone https://github.com/ly525/luban-h5 && cd luban-h5
65 # 安装依赖，构建前后端（安装依赖会耗时略长，请耐心等待） 66 # 安装依赖，构建前后端（安装依赖会耗时略长，请耐心等待）
@@ -71,13 +72,25 @@ git clone https://github.com/ly525/luban-h5 && cd luban-h5 @@ -71,13 +72,25 @@ git clone https://github.com/ly525/luban-h5 && cd luban-h5
71 # ./luban-h5.sh stop 72 # ./luban-h5.sh stop
72 ``` 73 ```
73 74
74 -- 更多细节，请参照 [鲁班H5-在线文档](https://ly525.github.io/luban-h5/zh/) 的 [`快速开始`](https://ly525.github.io/luban-h5/zh/getting-started/quick-start.html) 章节，进行配置即可 75 +#### 二、本地安装了 Node、Yarn
  76 +```bash
  77 +git clone https://github.com/ly525/luban-h5
  78 +cd luban-h5 # 项目根目录
75 79
76 -- 如果遇到接口 403 问题，请参照 [`快速开始`](https://ly525.github.io/luban-h5/zh/getting-started/quick-start.html) 章节，搜索关键字：403 即可 80 +# 后端
  81 +cd back-end/h5-api && yarn && yarn dev
  82 +
  83 +# 前端
  84 +# 新开一个终端，在项目根目录执行如下命令
  85 +cd front-end/h5 && yarn && yarn build:engine && yarn dev
77 86
  87 +# 启动项目访问 http://localhost:1337 即可
  88 +```
78 89
79 90
  91 +- 更多细节，请参照 [鲁班H5-在线文档](https://ly525.github.io/luban-h5/zh/) 的 [`快速开始`](https://ly525.github.io/luban-h5/zh/getting-started/quick-start.html) 章节，进行配置即可
80 92
  93 +- 如果遇到接口 403 问题，请参照 [`快速开始`](https://ly525.github.io/luban-h5/zh/getting-started/quick-start.html) 章节，搜索关键字：403 即可
81 94
82 ### 交流群 95 ### 交流群
83 96
@@ -135,7 +148,7 @@ git clone https://github.com/ly525/luban-h5 && cd luban-h5 @@ -135,7 +148,7 @@ git clone https://github.com/ly525/luban-h5 && cd luban-h5
135 148
136 149
137 #### 捐赠作者 150 #### 捐赠作者
138 -如果项目对您有用或者对您有启发，不妨通过微信或者支付宝进行小额捐赠，以支持该项目的持续维护和发展 151 +如果你觉得这个项目对你有用或者有所启发，可以请作者喝杯果汁：
139 | 微信捐赠 | 支付宝捐赠 152 | 微信捐赠 | 支付宝捐赠
140 |---|---| 153 |---|---|
141 | <img src="https://user-images.githubusercontent.com/12668546/81877522-e6165b00-95b7-11ea-9699-b74670a208d7.png" width="140" />| <img src="https://user-images.githubusercontent.com/12668546/81877535-ef9fc300-95b7-11ea-954a-03ae349908cd.png" width="140" /> 154 | <img src="https://user-images.githubusercontent.com/12668546/81877522-e6165b00-95b7-11ea-9699-b74670a208d7.png" width="140" />| <img src="https://user-images.githubusercontent.com/12668546/81877535-ef9fc300-95b7-11ea-954a-03ae349908cd.png" width="140" />