Cleaned up README

2020-06-04 08:04:57 +02:00
parent 1b11ba15d3
commit 5307238eae
2 changed files with 51 additions and 90 deletions
@@ -21,14 +21,46 @@ cd Shuffle
 docker-compose up -d
 ```

-## After installation 
+### After installation 
 1. After installation, go to http://localhost:3001/adminsetup (or your servername)

 2. Now set up your admin account (username & password). Shuffle doesn't have a default username and password.

 ![Admin account setup](shuffle_adminaccount.png)

-## Useful info
+### Useful info
 * The server is available on http://localhost:3001 (or your servername)
 * Further configurations can be done in docker-compose.yml and .env.
 * Default database location is /etc/shuffle
+
+
+
+## Local development installation 
+Frontend - requires [npm](https://nodejs.org/en/download/)/[yarn](https://yarnpkg.com/lang/en/docs/install/#debian-stable)/your preferred manager. Runs independently from backend - edit frontend/src/App.yaml (line 44~) from window.location.origin to http://YOUR IP:5001
+```bash
+cd frontend
+npm i
+npm start
+```
+
+Backend - API calls - requires [>=go1.13](https://golang.org/dl/) 
+```bash
+export DATASTORE_EMULATOR_HOST=0.0.0.0:8000
+cd backend/go-app
+go build
+go run *.go
+```
+
+Database - Datastore:
+```
+docker run -p 8000:8000 google/cloud-sdk gcloud beta emulators datastore start --project=shuffle --host-port 0.0.0.0:8000 --no-store-on-disk
+```
+
+Orborus - Execution of Workflows:
+PS: This requires some specific environment variables.
+```
+cd functions/onprem/orborus
+go run orborus.go
+```
+
+