Mercurial > gemma

annotate README.md @ 272:5ee0edc01a18

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Small typo fix.
author Sascha L. Teichmann <sascha.teichmann@intevation.de>
date Mon, 30 Jul 2018 12:32:52 +0200
parents a2f7049daf7f
children 9d6ba97a31d2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
266
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
1 # Quick Start
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
2
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
3 ## Build
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
4
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
5 - To build all components of gemma, simply type `make` on the top
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
6 level directory of the repro.
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
7
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
8 - To only (re)build the back end you can use `make gemma`.
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
9
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
10 - To only build the SPA-Client you can use `make client`.
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
11
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
12
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
13 ## Setup Database
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
14
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
15 - You will need a PostgreSQL cluster with PostGIS.
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
16
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
17 - To install the **gemma** schema and roles use the script
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
18 `./schema/install-db.sh`.
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
19
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
20 - `./schema/install-db.sh --help` shows you available options.
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
21 Per default the script will create a database named "gemma" and all
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
22 necessary roles in the postgres default cluster (listening on port
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
23 5432).
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
24
272
5ee0edc01a18 Small typo fix.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 266
diff changeset
25 - The script must be run as a user with PostgreSQL super user rights.
266
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
26 By convention this is the "postgres" on most systems.
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
27
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
28 - Standard case: as user "postgres", in the top level directory of the
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
29 repo run:
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
30
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
31 ## Running gemma
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
32
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
33 - In the top level directory of the repo run:
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
34 `./cmd/gemma/gemma -s session.data -w ./web`
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
35
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
36 - To listen on a specific port and interface:
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
37 ```
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
38 ./cmd/gemma/gemma -s session.data -w ./web \
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
39 --host 192.168.46.72 -p 8088
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
40 ```
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
41
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
42 - `./cmd/gemma/gemma -h` gives you an overview of more available
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
43 options.
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
44
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
45
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
46 # Manual setup
a2f7049daf7f Added some quickstart information to README.md
Sascha Wilde <wilde@intevation.de>
parents: 206
diff changeset
47
121
9a5bbe9c593c Split README into client and toplevel.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
48 ## Backend
9a5bbe9c593c Split README into client and toplevel.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
49
9a5bbe9c593c Split README into client and toplevel.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
50 In Go.
9a5bbe9c593c Split README into client and toplevel.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
51
9a5bbe9c593c Split README into client and toplevel.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
52 * Install dependencies
9a5bbe9c593c Split README into client and toplevel.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
53
9a5bbe9c593c Split README into client and toplevel.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
54 `sh 3rdpartylibs`
9a5bbe9c593c Split README into client and toplevel.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
55
9a5bbe9c593c Split README into client and toplevel.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
56 * Build
9a5bbe9c593c Split README into client and toplevel.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
57
9a5bbe9c593c Split README into client and toplevel.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
58 Prerequesite: compile server
9a5bbe9c593c Split README into client and toplevel.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
59 ```
206
cd6ad5eaef8d Renamed cmd/tokenserver to cmd/gemma.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 121
diff changeset
60 cd cmd/gemma/
121
9a5bbe9c593c Split README into client and toplevel.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
61 go build
9a5bbe9c593c Split README into client and toplevel.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
62 cd ../../
9a5bbe9c593c Split README into client and toplevel.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
63 ```
9a5bbe9c593c Split README into client and toplevel.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
64
9a5bbe9c593c Split README into client and toplevel.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
65 * Run
206
cd6ad5eaef8d Renamed cmd/tokenserver to cmd/gemma.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 121
diff changeset
66 Run server with `./cmd/gemma/gemma`
121
9a5bbe9c593c Split README into client and toplevel.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
67
9a5bbe9c593c Split README into client and toplevel.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
68
9a5bbe9c593c Split README into client and toplevel.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
69 ## Client
9a5bbe9c593c Split README into client and toplevel.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
70
9a5bbe9c593c Split README into client and toplevel.
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
71 See [client/README](client/README.md).