Mercurial > gemma

comparison README.md @ 266:a2f7049daf7f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added some quickstart information to README.md
author Sascha Wilde <wilde@intevation.de>
date Mon, 30 Jul 2018 11:06:50 +0200
parents cd6ad5eaef8d
children 5ee0edc01a18
comparison
equal deleted inserted replaced
265:d2fb83291c68 266:a2f7049daf7f
1 # Quick Start
2
3 ## Build
4
5 - To build all components of gemma, simply type `make` on the top
6 level directory of the repro.
7
8 - To only (re)build the back end you can use `make gemma`.
9
10 - To only build the SPA-Client you can use `make client`.
11
12
13 ## Setup Database
14
15 - You will need a PostgreSQL cluster with PostGIS.
16
17 - To install the **gemma** schema and roles use the script
18 `./schema/install-db.sh`.
19
20 - `./schema/install-db.sh --help` shows you available options.
21 Per default the script will create a database named "gemma" and all
22 necessary roles in the postgres default cluster (listening on port
23 5432).
24
25 - The script mus be run as a user with PostgreSQL super user rights.
26 By convention this is the "postgres" on most systems.
27
28 - Standard case: as user "postgres", in the top level directory of the
29 repo run:
30
31 ## Running gemma
32
33 - In the top level directory of the repo run:
34 `./cmd/gemma/gemma -s session.data -w ./web`
35
36 - To listen on a specific port and interface:
37 ```
38 ./cmd/gemma/gemma -s session.data -w ./web \
39 --host 192.168.46.72 -p 8088
40 ```
41
42 - `./cmd/gemma/gemma -h` gives you an overview of more available
43 options.
44
45
46 # Manual setup
47
1 ## Backend 48 ## Backend
2 49
3 In Go. 50 In Go.
4 51
5 * Install dependencies 52 * Install dependencies