view README.md @ 271:02aaff4b4a66

Merged.
author Sascha L. Teichmann <sascha.teichmann@intevation.de>
date Mon, 30 Jul 2018 12:32:11 +0200
parents a2f7049daf7f
children 5ee0edc01a18
line wrap: on
line source

# 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.

* Install dependencies

    `sh 3rdpartylibs`

* Build

    Prerequesite: compile server
    ```
    cd cmd/gemma/
    go build
    cd ../../
    ```

* Run
    Run server with  `./cmd/gemma/gemma`


## Client

See [client/README](client/README.md).