view README.md @ 291:9d6ba97a31d2

Moved development infos to separate file.
author Sascha L. Teichmann <sascha.teichmann@intevation.de>
date Tue, 31 Jul 2018 12:47:09 +0200
parents 5ee0edc01a18
children fd04bccae6ca
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`.

For further details see [docs/DEVELOPMENT](docs/DEVELOPMENT.md),


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