From 5c901e452219303c2f3740349232e7ddb087d165 Mon Sep 17 00:00:00 2001 From: Fernandez Ludovic Date: Wed, 7 Oct 2015 13:54:00 +0200 Subject: [PATCH] docs(webui): add documentation --- static/readme.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 static/readme.md diff --git a/static/readme.md b/static/readme.md new file mode 100644 index 000000000..8ac670cb2 --- /dev/null +++ b/static/readme.md @@ -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) +