diff --git a/README.md b/README.md index 39ae54c3..bd5d26d6 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,20 @@ -Apache SkyWalking Booster UI -=============== +# Apache SkyWalking Booster UI Sky Walking logo -[Apache SkyWalking](https://github.com/apache/skywalking) Booster UI. +[Apache SkyWalking](https://github.com/apache/skywalking) Booster UI. ![NPM BUILD](https://github.com/apache/skywalking-booster-ui/workflows/Node%20CI/badge.svg) This UI starts from SkyWalking OAP v9 core. ## Release + This repo wouldn't release separately. All source codes have been included in the main repo release. The tags match the [main repo](https://github.com/apache/skywalking) tags. ## Development - The app was built with [Vue3.x + Typescript](https://github.com/vuejs/vue). +The app was built with [Vue3.x + Typescript](https://github.com/vuejs/vue). ### Prepare @@ -28,19 +28,21 @@ npm install ### Build **All following builds are for dev.** + ``` npm install -npm run serve +npm run dev ``` The default UI address is `http://localhost:8080`. - # Contact Us -* Submit an [issue](https://github.com/apache/skywalking/issues) if you face some issues. Submit a [discussion](https://github.com/apache/skywalking/discussions) if you want to propose new feature or have any question. -* Mailing list: **dev@skywalking.apache.org**. Mail to `dev-subscribe@skywalking.apache.org`, follow the reply to subscribe the mailing list. -* Join Slack. Send `Request to join SkyWalking slack` mail to the mail list(`dev@skywalking.apache.org`), we will invite you in. -* QQ Group: 392443393, 901167865 + +- Submit an [issue](https://github.com/apache/skywalking/issues) if you face some issues. Submit a [discussion](https://github.com/apache/skywalking/discussions) if you want to propose new feature or have any question. +- Mailing list: **dev@skywalking.apache.org**. Mail to `dev-subscribe@skywalking.apache.org`, follow the reply to subscribe the mailing list. +- Join Slack. Send `Request to join SkyWalking slack` mail to the mail list(`dev@skywalking.apache.org`), we will invite you in. +- QQ Group: 392443393, 901167865 # License + [Apache 2.0 License.](/LICENSE)