diff --git a/README.md b/README.md index 256f39c89c75820047e42d046bee202727e60558..4c0c934a72e52576fb6927bd2c641987b05de73c 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,10 @@ This application was created by Eike Cochu for his master's degree thesis in com ## Components -* 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-backend: Backend application that connects to the database, filebase and search engine. [README](vipra-backend/README.md) +* vipra-cmd: Backend utility tool to import and manage backend services. [README](vipra-cmd/README.md) +* vipra-ui: Frontend user interface that connects to the backend REST service. [README](vipra-ui/README.md) +* vipra-util: Shared libraries and classes for backend applications and utility tools. [README](vipra-util/README.md) ## Installation @@ -35,11 +35,18 @@ The following steps were reproduced in that order on a fully updated Ubuntu 15.1 sudo apt-get install openjdk-8-jdk mongodb git maven tomcat8 libgsl0-dev ``` - test if MongoDB is available: + enable and test MongoDB: ```bash + sudo systemctl enable mongodb + sudo systemctl restart mongodb mongo ``` + if watchman will be used (see below) additional packages are required for building watchman from source + ```bash + build-essential autoconf automake python-dev + ``` + 2. install a recent version of **nodejs** (the official repositories contain old versions) ```bash curl -sL https://deb.nodesource.com/setup_5.x | sudo -E bash - @@ -47,11 +54,6 @@ The following steps were reproduced in that order on a fully updated Ubuntu 15.1 # gulp needs a node executable, ubuntu only creates a nodejs executable sudo ln -s /usr/bin/nodejs /usr/bin/node ``` - - if watchman will be used (see below) additional packages are required for building watchman from source - ```bash - build-essential autoconf automake python-dev - ``` 3. Install **required node packages** for frontend development ```bash @@ -78,7 +80,7 @@ The following steps were reproduced in that order on a fully updated Ubuntu 15.1 sudo dpkg -i elasticsearch-2.2.0.deb rm elasticsearch-2.2.0.deb sudo systemctl enable elasticsearch - sudo systemctl start elasticsearch + sudo systemctl restart elasticsearch ``` and test if it is available: