This is an automated email from the ASF dual-hosted git repository. juzhiyuan pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/apisix-dashboard.git
The following commit(s) were added to refs/heads/master by this push: new d3ca36d Update README.md (#379) d3ca36d is described below commit d3ca36df0a5844eb5461c2bbfa34fccc984dc5be Author: 琚致远 <juzhiy...@apache.org> AuthorDate: Mon Aug 17 09:09:37 2020 +0800 Update README.md (#379) * Update README.md * Update README.md * Create Preview.md * feat(Doc): added snapshots for Preview * feat(Doc): update images * feat(Doc): update images * Update README.md --- README.md | 11 ++++++++--- USER_GUIDE.md | 33 +++++++++++++++++++++++++++++++++ images/metrics-cn.png | Bin 0 -> 168247 bytes images/metrics-en.png | Bin 0 -> 173219 bytes images/route-create-done-list-cn.png | Bin 0 -> 198788 bytes images/route-create-done-list-en.png | Bin 0 -> 194466 bytes images/route-create-step1-cn.png | Bin 0 -> 249406 bytes images/route-create-step1-en.png | Bin 0 -> 255509 bytes images/route-create-step2-cn.png | Bin 0 -> 240242 bytes images/route-create-step2-en.png | Bin 0 -> 250320 bytes images/route-create-step3-cn.png | Bin 0 -> 272421 bytes images/route-create-step3-en.png | Bin 0 -> 281334 bytes images/route-create-step4-cn.png | Bin 0 -> 249683 bytes images/route-create-step4-en.png | Bin 0 -> 259689 bytes images/route-list-en.png | Bin 0 -> 183974 bytes images/setting-cn.png | Bin 0 -> 154318 bytes images/setting-en.png | Bin 0 -> 159045 bytes images/ssl-list-cn.png | Bin 0 -> 175245 bytes images/ssl-list-en.png | Bin 0 -> 177151 bytes 19 files changed, 41 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 36c348b..5f82c63 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,11 @@ Dashboard for [Apache APISIX](https://github.com/apache/apisix-dashboard) +[Online demo](http://139.217.190.60/) + +## User Guide +Please refer to [User Guide](./USER_GUIDE.md) + ## Deploy with Docker Please refer to [Deploy with Docker README](./compose/README.md) @@ -42,7 +47,7 @@ The `manager-api` is used to provide APIs for Dashboard, just like a bridge betw 1. We need `MySQL/Golang` to be preinstalled. ```sh -# e.g Initialization for MySQL +# e.g Initialization for MySQL, please use a more secure Password instead of 123456. $ mysql –uroot –p123456 > source ./api/script/db/schema.sql ``` @@ -55,7 +60,7 @@ $ mysql –uroot –p123456 According to your local deployment environment, check the environment variables in `./api/run/run.sh`, modify the environment variables if needed. -For Chinese users please refer to [Goproxy](https://goproxy.cn/) +For most users in China, we could use [Goproxy](https://goproxy.cn/) to speed up downloading modules. 4. Build @@ -87,7 +92,7 @@ $ yarn install $ yarn build ``` -5. The bundled files are under `/dist` folder if the step 4 is successful, then we recommend using `nginx` to handle those files, please refer to the nginx conf `docker/nginx.conf`. +5. The bundled files are under `/dist` folder if the step 4 is successful, then we recommend using `nginx` to handle those files, please install `nginx` manually, then refer to the nginx conf `docker/nginx.conf`. 6. Move files under `dist` folder to nginx's default html folder, then visit `http://127.0.0.1` in your browser. ## Development diff --git a/USER_GUIDE.md b/USER_GUIDE.md new file mode 100644 index 0000000..659850f --- /dev/null +++ b/USER_GUIDE.md @@ -0,0 +1,33 @@ +# User Guide + +Please visit [http://139.217.190.60/](http://139.217.190.60/) in browser to have a full-preview of the Apache APISIX Dashboard. + +The following are parts of the modules' snapshot. + +## Metrics + +![metrics-en](./images/metrics-en.png) + +## Route + +The Route module aims to control routes by UI instead of calling APIs. + +### List + +![route-list](./images/route-list-en.png) + +### Create + +![route-create-step1-en](./images/route-create-step1-en.png) + +![route-create-step2-en](./images/route-create-step2-en.png) + +![route-create-step3-en](./images/route-create-step3-en.png) + +![route-create-step4-en](./images/route-create-step4-en.png) + +![route-create-done-list-en](./images/route-create-done-list-en.png) + +## Setting + +![setting](./images/setting-en.png) diff --git a/images/metrics-cn.png b/images/metrics-cn.png new file mode 100644 index 0000000..225154f Binary files /dev/null and b/images/metrics-cn.png differ diff --git a/images/metrics-en.png b/images/metrics-en.png new file mode 100644 index 0000000..ab3f67c Binary files /dev/null and b/images/metrics-en.png differ diff --git a/images/route-create-done-list-cn.png b/images/route-create-done-list-cn.png new file mode 100644 index 0000000..164a5ab Binary files /dev/null and b/images/route-create-done-list-cn.png differ diff --git a/images/route-create-done-list-en.png b/images/route-create-done-list-en.png new file mode 100644 index 0000000..3982888 Binary files /dev/null and b/images/route-create-done-list-en.png differ diff --git a/images/route-create-step1-cn.png b/images/route-create-step1-cn.png new file mode 100644 index 0000000..39dbfc5 Binary files /dev/null and b/images/route-create-step1-cn.png differ diff --git a/images/route-create-step1-en.png b/images/route-create-step1-en.png new file mode 100644 index 0000000..7dd42ca Binary files /dev/null and b/images/route-create-step1-en.png differ diff --git a/images/route-create-step2-cn.png b/images/route-create-step2-cn.png new file mode 100644 index 0000000..fe9fad4 Binary files /dev/null and b/images/route-create-step2-cn.png differ diff --git a/images/route-create-step2-en.png b/images/route-create-step2-en.png new file mode 100644 index 0000000..687b8f3 Binary files /dev/null and b/images/route-create-step2-en.png differ diff --git a/images/route-create-step3-cn.png b/images/route-create-step3-cn.png new file mode 100644 index 0000000..5836f5b Binary files /dev/null and b/images/route-create-step3-cn.png differ diff --git a/images/route-create-step3-en.png b/images/route-create-step3-en.png new file mode 100644 index 0000000..f5c6185 Binary files /dev/null and b/images/route-create-step3-en.png differ diff --git a/images/route-create-step4-cn.png b/images/route-create-step4-cn.png new file mode 100644 index 0000000..e1e4007 Binary files /dev/null and b/images/route-create-step4-cn.png differ diff --git a/images/route-create-step4-en.png b/images/route-create-step4-en.png new file mode 100644 index 0000000..58b006b Binary files /dev/null and b/images/route-create-step4-en.png differ diff --git a/images/route-list-en.png b/images/route-list-en.png new file mode 100644 index 0000000..6206426 Binary files /dev/null and b/images/route-list-en.png differ diff --git a/images/setting-cn.png b/images/setting-cn.png new file mode 100644 index 0000000..a22670d Binary files /dev/null and b/images/setting-cn.png differ diff --git a/images/setting-en.png b/images/setting-en.png new file mode 100644 index 0000000..dd69625 Binary files /dev/null and b/images/setting-en.png differ diff --git a/images/ssl-list-cn.png b/images/ssl-list-cn.png new file mode 100644 index 0000000..1fb699b Binary files /dev/null and b/images/ssl-list-cn.png differ diff --git a/images/ssl-list-en.png b/images/ssl-list-en.png new file mode 100644 index 0000000..fac5031 Binary files /dev/null and b/images/ssl-list-en.png differ