changeset 266:a2f7049daf7f

Added some quickstart information to README.md
author Sascha Wilde <wilde@intevation.de>
date Mon, 30 Jul 2018 11:06:50 +0200
parents d2fb83291c68
children 7f030ec3472d
files README.md
diffstat 1 files changed, 47 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Fri Jul 27 16:30:06 2018 +0200
+++ b/README.md	Mon Jul 30 11:06:50 2018 +0200
@@ -1,3 +1,50 @@
+# Quick Start
+
+## Build
+
+- To build all components of gemma, simply type `make` on the top
+  level directory of the repro.
+
+- To only (re)build the back end you can use `make gemma`.
+
+- To only build the SPA-Client you can use `make client`.
+
+
+## Setup Database
+
+- You will need a PostgreSQL cluster with PostGIS.
+
+- To install the **gemma** schema and roles use the script
+  `./schema/install-db.sh`.
+
+- `./schema/install-db.sh --help` shows you available options.
+  Per default the script will create a database named "gemma" and all
+  necessary roles in the postgres default cluster (listening on port
+  5432).
+
+- The script mus be run as a user with PostgreSQL super user rights.
+  By convention this is the "postgres" on most systems.
+
+- Standard case: as user "postgres", in the top level directory of the
+  repo run:
+
+## Running gemma
+
+- In the top level directory of the repo run:
+  `./cmd/gemma/gemma -s session.data -w ./web`
+
+- To listen on a specific port and interface:
+  ```
+  ./cmd/gemma/gemma -s session.data -w ./web \
+                    --host 192.168.46.72 -p 8088
+  ```
+
+- `./cmd/gemma/gemma -h` gives you an overview of more available
+  options.
+
+
+# Manual setup
+
 ## Backend
 
 In Go.