README.md 2.7 KB
Newer Older
M
min 已提交
1
# Dubbo Admin
马金凯 已提交
2

3 4 5
[![Build Status](https://travis-ci.org/apache/incubator-dubbo-admin.svg?branch=develop)](https://travis-ci.org/apache/incubator-dubbo-admin)
[![codecov](https://codecov.io/gh/apache/incubator-dubbo-admin/branch/develop/graph/badge.svg)](https://codecov.io/gh/apache/incubator-dubbo-admin)
![license](https://img.shields.io/github/license/apache/incubator-dubbo-admin.svg)
kimmking's avatar
kimmking 已提交
6

N
nzomkxia 已提交
7
[中文说明](README_ZH.md)
M
min 已提交
8 9
### Demo Address
* http://47.91.207.147/#/service
N
nzomkxia 已提交
10
* this demo is the latest version of `develop` branch, you can try it before building from source code
马金凯 已提交
11
### Screenshot
W
WangXin 已提交
12

13
![index](https://raw.githubusercontent.com/apache/incubator-dubbo-admin/develop/doc/images/index.png)
N
nzomkxia 已提交
14

M
min 已提交
15
### Service Governance  
16
service governance follows the version of Dubbo 2.7, and compatible for Dubbo 2.6, please refer to [here](https://github.com/apache/incubator-dubbo-admin/wiki/The-compatibility-of-service-governance)
N
nzomkxia 已提交
17
### admin UI
马金凯 已提交
18 19

- [Vue.js](https://vuejs.org) and [Vuetify](https://vuetifyjs.com)
N
nzomkxia 已提交
20
- [dubbo-admin-ui/README.md](dubbo-admin-ui/README.md) for more detail
N
nzomkxia 已提交
21
- Set npm **proxy mirror**: you can set npm proxy mirror to speedup npm install: add `registry =https://registry.npm.taobao.org` to ~/.npmrc
马金凯 已提交
22

N
nzomkxia 已提交
23
### admin Server
马金凯 已提交
24

N
nzomkxia 已提交
25
* Standard spring boot project
26
* [configurations in application.properties](https://github.com/apache/incubator-dubbo-admin/wiki/Dubbo-Admin-configuration)
N
nzomkxia 已提交
27

28

N
nzomkxia 已提交
29
### Production Setup
N
nzomkxia 已提交
30

31
1. Clone source code on develop branch `git clone https://github.com/apache/incubator-dubbo-admin.git`
32
2. Specify registry address in `dubbo-admin-server/src/main/resources/application-production.properties`
N
nzomkxia 已提交
33
3. Build
N
nzomkxia 已提交
34

N
nzomkxia 已提交
35
    > - `mvn clean package`  
M
min 已提交
36
4. Start 
37
    * `mvn --projects dubbo-admin-server spring-boot:run`  
M
min 已提交
38
    OR
N
nzomkxia 已提交
39
    * `cd dubbo-admin-distribution/target`;   `java -jar dubbo-admin-0.1.jar`
马金凯 已提交
40
5. Visit `http://localhost:8080`
N
nzomkxia 已提交
41
---
N
nzomkxia 已提交
42 43

### Development Setup
N
nzomkxia 已提交
44
* Run admin server project
N
nzomkxia 已提交
45
   backend is a standard spring boot project, you can run it in any java IDE
N
nzomkxia 已提交
46
* Run admin ui project
N
nzomkxia 已提交
47
  run with `npm run dev`.
N
nzomkxia 已提交
48 49 50
* visit web page
  visit `http://localhost:8081`, frontend supports hot reload.
 * CORS problem
N
nzomkxia 已提交
51
    for the convenience of development, we deploy ui and server separately, so the frontend supports hot reload. In this mode, frontend will request `localhost:8080` to fetch data, this will cause a CORS problem, so we add a configuration in `dubbo-admin-ui/config/index.js` to support CORS. This config will be activated under `npm run dev` mode.
N
nzomkxia 已提交
52

N
nzomkxia 已提交
53
### Swagger support
N
nzomkxia 已提交
54 55 56

Once deployed, you can check http://localhost:8080/swagger-ui.html to check all restful api and models

N
nzomkxia 已提交
57

马金凯 已提交
58
### License
K
kimmking 已提交
59

60 61
Apache Dubbo admin is under the Apache 2.0 license, Version 2.0.
See [LICENSE](https://github.com/apache/incubator-dubbo-admin/blob/develop/LICENSE) for full license text.