From 8cee7af1cce182221fbf6dbd551ffc16eaa02504 Mon Sep 17 00:00:00 2001
From: Timo Erdelt <erdelt@cip.ifi.lmu.de>
Date: Sun, 18 Feb 2018 22:41:46 +0100
Subject: [PATCH] Update README.md

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/README.md b/README.md
index e69de29..4e5ed54 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,28 @@
+## Minimal Requirements
+
+ 
+1. SBT Version 1.1.0
+2. IntelliJ IDEA 2017.3.4 (for editing)
+
+## Backend Setup
+
+1. Clone repository
+2. `cd backend`
+3. `sbt run`
+
+## Frontend Setup
+
+1. Clone repository
+2. `cd frontend`
+3. `yarn install`
+4. `sbt ~fastOptJS` (hint `sbt clean run`)
+5. `npm run start`
+6. Open in browser `http://localhost:8080`
+
+## Access locally running server and website from mobile device
+
+1. Find out your local IP adress 
+2. open `frontend/package.json` and edit `"scripts": { "mobile": "API_HOST=...:5000` to `API_HOST=yourlocalIPadress:5000`
+3. `sbt ~fastOptJS`
+4. `npm run mobile`
+5. Open your mobile browser and go to `yourlocalIPadress:8080` (you might have to disable firewall first)