Merge pull request #16 from TinyAllen/develop

Merge from Develop branch
tree: cf6cc4c56651fb50146e331f59bb98f37b2b27e7
  1. build/
  2. config/
  3. document/
  4. src/
  5. static/
  6. .babelrc
  7. .editorconfig
  8. .eslintignore
  9. .eslintrc.js
  10. .gitignore
  11. .postcssrc.js
  12. Dockerfile
  13. Dockerfile-ci
  14. Document.md
  15. index.html
  16. LICENSE
  17. nginx.conf
  18. package.json
  19. README.md
  20. run.sh
  21. tsconfig.json
  22. tslint.json
README.md

Introduction

RocketBot is an MIT-licensed open source project. It‘s UI for Apache SkyWalking. This project is supported By DaoCloud Labs.

Demo

Docs

Development

The app was built with vue + typescript.

Getting codes

Fork, then clone the rocketbot repo and change directory into it.

git clone https://github.com/TinyAllen/rocketbot.git
cd rocketbot

Install dependencies via npm:

npm install

Running the application

The default collector query address is http://localhost:8080.

Commands

CommandDescription
npm startStarts development server with hot reloading.
npm run hostStarts development servers other can link
npm run lintLint the project (tslint)
npm run buildRuns production build. Outputs files to /dist.

Build

Running build will output all the static files to the ./dist folder:

npm install
npm run build

Docker Image Build

npm install

npm run build

docker build -t rocketbot .

Running the docker image

docker run -p 8080:80 -d -e SKYWALKING_URL=127.0.0.1:1234,127.0.0.1:1235 rocketbot

SKYWALKING_URL is the address of your backend, multiple IP is changed by comma.

The default frontend address is http://localhost:8080.

Nginx config

Reserve proxy

  location /api {
    rewrite ^/(.*) /graphql break;
    proxy_pass SKYWALKING_URL;
  }

Important: If you want to deploy the application by yourself,you need to rewirte the URL path into /graphql before reserve proxy.

Contributing to RocketBot

Firstly, thanks for your interest in contributing! I hope that this will be a pleasant first experience for you, and that you will return to continue contributing.

How to contribute?

Most of the contributions that we receive are code contributions, but you can also contribute to the documentation or simply report solid bugs for us to fix.

How to report a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Support

Supported by DaoCloud Labs.

Contact

微信群 & 作者微信

License

Copyright © 2018, Allen Wang. Released under the MIT License.

Who Uses Rocketbot?

按照登记顺序排序,更多接入公司,欢迎在 https://github.com/TinyAllen/rocketbot/issues/15 登记(仅供开源用户参考)