Skip to content

Commit 50a31c8

Browse files
authored
Update README.md
1 parent fed55bb commit 50a31c8

1 file changed

Lines changed: 20 additions & 1 deletion

File tree

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,27 @@
11
# TaskOverflow client
2-
This is tha Angular client for the grails server.
2+
This is tha Angular client for the grails server by Benoît Garçon.
33

44
To start it just use:
55
```
66
nmp start
77
```
8+
You should be able to reach it at [http://localhost:8000](http://localhost:8000).
89

10+
## Stateless application
11+
This application is totally stateless.
12+
13+
## Authentification mechanism
14+
This application is secured through spring-security-rest.
15+
16+
## Feature Flipping
17+
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.
18+
19+
## Health check
20+
The complete Health Check is available at [http://localhost:8080/health](http://localhost:8080/health).
21+
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.
22+
23+
## Circuit Breaker
24+
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.
25+
26+
## Graceful Degradation
27+
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 commit comments

Comments
 (0)