Merge branch 'master' of git.cochu.io:master-thesis/ma-impl

README.md

@@ -9,4 +9,30 @@ This application was created by Eike Cochu for his master's degree thesis in com
 * vipra-backend: Backend application that connects to the database, filebase and search engine.
 * vipra-cmd: Backend utility tool to import and manage backend services.
 * vipra-ui: Frontend user interface that connects to the backend REST service.
-* vipra-util: Shared libraries and classes for backend applications and utility tools.
+* vipra-util: Shared libraries and classes for backend applications and utility tools.
\ No newline at end of file
+
+## Installation
+
+### Requirements
+
+Run dependencies
+
+* [Java (8+)](https://www.java.com/)
+* [MongoDB (2.6+)](https://www.mongodb.org/)
+* [ElasticSearch (2.1+)](https://www.elastic.co/products/elasticsearch)
+* [DynamicDTM](https://code.google.com/archive/p/princeton-statistical-learning/downloads)
+* JavaEE Application Server, e.g. [Tomcat (8+)](https://tomcat.apache.org/)
+
+Additional build dependencies
+
+* [Maven (3+)](https://maven.apache.org/)
+* [Gulp (3.9+)](http://gulpjs.com/)
+* [Bower (1.7+](http://bower.io/)
+
+### Installation
+
+1. Clone this repository to `./vipra`
+2. Navigate to `./vipra`
+3. Execute `./build.sh` to build all projects
+4. Copy `vipra-backend/target/vipra.war` to your JavaEE application server
+5. Test connections by running `./vipra -t`
\ No newline at end of file