Skip to content

Commit

Permalink
Add introduction for SC UI and update Api Docs (#131)
Browse files Browse the repository at this point in the history
* Create Readme.md

* Update Readme.md

* Add files via upload

* Update Readme.md

* Delete Service-Center-UI-Preview.gif

* Add files via upload

* Update README.md

* Delete html2 api docs

* Add html client Api docs

* Updated the SC UI port
  • Loading branch information
asifdxtreme committed Oct 24, 2017
1 parent 278cb0f commit 4b43f08
Show file tree
Hide file tree
Showing 4 changed files with 3,361 additions and 30,389 deletions.
2 changes: 1 addition & 1 deletion README.md
@@ -1,7 +1,7 @@
# service-center
[![Build Status](https://travis-ci.org/ServiceComb/service-center.svg?branch=master)](https://travis-ci.org/ServiceComb/service-center) [![Coverage Status](https://coveralls.io/repos/github/ServiceComb/service-center/badge.svg?branch=master)](https://coveralls.io/github/ServiceComb/service-center?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/ServiceComb/service-center)](https://goreportcard.com/report/github.com/ServiceComb/service-center) [![GoDoc](https://godoc.org/github.com/ServiceComb/service-center?status.svg)](https://godoc.org/github.com/ServiceComb/service-center)

A standalone service center allows services to register their instance information and to discover providers of a given service.
A standalone service center allows services to register their instance information and to discover providers of a given service. It also offers an awesome [web portal](/frontend) to manage the micro-services.

## Quick Start

Expand Down
Binary file added docs/Service-Center-UI-Preview.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33,706 changes: 3,318 additions & 30,388 deletions docs/api-docs.html

Large diffs are not rendered by default.

42 changes: 42 additions & 0 deletions frontend/Readme.md
@@ -0,0 +1,42 @@
## Service-Center UI

Service-Center UI enables user to view the list of MicroServices registered in SC. Users can view the detailed information of their MicroServices, Instances and Schemas.
Service-Center UI also offers a unique feature of testing the Schemas of their MicroServices from UI, Users can also download the html client for their Schemas.

### QuickStart Guide

Easiest way to get started with Service-Center UI is to download the release from [here](https://github.com/ServiceComb/service-center/releases) and then untar/unzip it based on your OS and run start.sh/start.bat.
This will bring up the Service-Center UI on [http://127.0.0.1:30103](http://127.0.0.1:30103).

##### Running UI from source code
However if you want to try our latest code then you can follow the below steps
```
#Make sure your GOPATH is set correctly as the UI runs on GO Backend Server
git clone https://github.com/ServiceComb/service-center.git $GOPATH/src/github.com/ServiceComb/service-center
cd $GOPATH/src/github.com/ServiceComb/service-center
cd frontend
go run main.go
```
This will bring up the Service-Center UI on [http://127.0.0.1:30103](http://127.0.0.1:30103).

### Preview of Service-Center UI
![Service-Center Preview](/docs/Service-Center-UI-Preview.gif)

### Feature List and RoadMap of Service-Center UI
Below is the comprehensive list of features which Service-Center UI offers, we are working constantly to improve the user experience and offer more useful features to leverage the features offered by Service-Center.
We Welcome our community members to come forward and help us to build this UI together.

|Sl|Feature|Status|
|--|-------|------|
|1|Dashobard to display the overall MicroService Statistics|Done|
|2|Service List with basic Information| Done|
|3|Instance List for MicroServices| Done|
|4|Provider List for MicroServices|Done|
|5|Consumer List for MicroServices|Done|
|6|Schema List for MicroServices|Done|
|7|Test Schema for MicroServices|InProgress|
|8|Generate Client from Schema |TBD|
|9|Generate Server from Schema|TBD|

Any Contribution(issues,PR,Documentation,Translation) will be highly appreciated.

0 comments on commit 4b43f08

Please sign in to comment.