Merge pull request #42 from ldez/feature/web-ui-documentation

docs(webui): add documentation
This commit is contained in:
Emile Vauge 2015-10-07 14:41:57 +02:00
commit f927c7dd0b

29
static/readme.md Normal file
View file

@ -0,0 +1,29 @@
# Træfɪk Web UI
Access to Træfɪk Web UI, ex: http://localhost:8080
## Interface
Træfɪk Web UI provide 2 types of informations:
- Providers with their backends and frontends information.
- Health of the web server.
## Build
Install [Node](https://nodejs.org).
Do `npm install` and `bower install`
## Libraries
- [Node](https://nodejs.org)
- [NPM](https://npmjs.com)
- [NPM - Documentation](https://docs.npmjs.com/)
- [AngularJS](https://docs.angularjs.org/api)
- [UI Router](https://github.com/angular-ui/ui-router)
- [UI Router - Documentation](https://github.com/angular-ui/ui-router/wiki)
- [Bootstrap](http://getbootstrap.com)
- [Angular Bootstrap](https://angular-ui.github.io/bootstrap)