diff --git a/README.md b/README.md index 7f4854ace..909205e1d 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,7 @@ [![License](http://img.shields.io/badge/license-apache%20v2-blue.svg)](https://github.com/KubeSphere/KubeSphere/blob/master/LICENSE) ---- - -***KubeSphere*** is a distribution of [Kubernetes](https://kubernetes.io), aimed to provide quick setup, friendly and easily use, and powerful management features for Kubernetes clusters, which could help both personal and enterprise users, reduce their learning curve of Kubernetes, accelerate their transform process from other container platforms to Kubernetes. +***KubeSphere*** is a distribution of [Kubernetes](https://kubernetes.io), aimed to provide quick setup, friendly and easily use, and powerful management features for Kubernetes clusters, which could help both personal and enterprise users, reduce their learning curve of Kubernetes, accelerate their transform process from other container platforms to Kubernetes.   **Features:** - Multiple IaaS platform support, including baremetal/KVM/QingCloud, and more will be supported in future release. diff --git a/docs/modules/app-manager/README.md b/docs/modules/app-manager/README.md new file mode 100644 index 000000000..c13c13080 --- /dev/null +++ b/docs/modules/app-manager/README.md @@ -0,0 +1,22 @@ +## QuickStart +KubeSphere uses same app-manager module from [OpenPitrix](https://github/openpitrix/openpitrix), which is another open source project initiated by QingCloud. +For testing and development purpose, follow steps below to setup app-manager service locally: +* Make sure git and docker runtime is installed in your local environment +* Clone the OpenPitrix project to your local environment: + ```console + git clone https://github.com/openpitrix/openpitrix.git + ``` +* Get into openpitrix directory, run commands below: + ```console + cd openpitrix + make build + make compose-up-app + ``` + +## Test app-manager + +Visit http://127.0.0.1:9100/swagger-ui in browser, and try it online, or test app-manager api service via command line: + +```shell +$ curl http://localhost:9100/v1/apps +{"total_items":0,"total_pages":0,"page_size":10,"current_page":1} \ No newline at end of file