Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
begarco authored Mar 15, 2017
1 parent fed55bb commit 50a31c8
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,27 @@
# TaskOverflow client
This is tha Angular client for the grails server.
This is tha Angular client for the grails server by Benoît Garçon.

To start it just use:
```
nmp start
```
You should be able to reach it at [http://localhost:8000](http://localhost:8000).

## Stateless application
This application is totally stateless.

## Authentification mechanism
This application is secured through spring-security-rest.

## Feature Flipping
The Feature Flipping is implemented: it use the [configuration server](http://github.com/TaskOverflow/conf) of this project. To test the feature flipping on a feature, you just need to switch between 'ok' and 'ko' in the corresponding file in [conf/data/](http://github.com/TaskOverflow/conf/data). Warning: it is important to run the configuration server from root (like it is said in the corresponding README). Every five seconds the client ping each features to know if the feature is activated.

## Health check
The complete Health Check is available at [http://localhost:8080/health](http://localhost:8080/health).
Some simplified Health Check are available for each features (user, badge, tag, question) at http://localhost:8080/featureName/healthcheck, it is used in Circuit Breaker feature.

## Circuit Breaker
The Circuit Breaker is implemented with the help of previously described feature healthcheck. Every five seconds the client ping each features to know if they respond 200 or an error. In the opened mode the circuit waits 20 seconds. If you want to play with the circuit breaker, you have to launch the server with `grails run-app` and modify the code returned by healthcheck() action of the desired controller. Or you can just break the server.

## Graceful Degradation
If there is a problem, some features are simply deleted from the UI (badge, tag), other features are replaced by new third party service : when user feature is down a list of random people is displayed, when question feature is down random gif of cats are displayed instead.

0 comments on commit 50a31c8

Please sign in to comment.