Skip to content

Commit

Permalink
Add instructions for a development setup to README
Browse files Browse the repository at this point in the history
  • Loading branch information
awoestmann committed Jul 10, 2024
1 parent 800b7d3 commit 2d01141
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,51 @@ geografischen Daten können Sachdaten mit den erfassten Informationen
verschnitten werden. Darüber hinaus können automatisch Einträge in Datensätze
aufgrund ihrer räumlichen Zugehörigkeit zu beispielsweise
Entwässerungsgebieten, Wasserschutzgebieten etc. generiert werden.

## Entwicklungsumgebung

Für das Aufsetzen einer Entwicklungsumgebung wird zuerst eine PostgreSQL-Datenbank benötigt.
Diese kann über das vorhandene Dockerfile erstellt werden:

```bash
docker build -t auik/db -f docker/Dockerfile .
docker run --name auik_db -p15432:5432 -v $PWD/data/db:/opt/auik_db -d auik/db
```

Die Datenbank ist dann unter Port `15432` mit dem Datenbanknamen `fisumwelt` erreichbar. Ein Login ist möglich als Nutzer `auikadmin` mit dem Passwort `secret`.

Alternativ kann die Datenbank über die Skripte in `data/db` manuell erstellt werden.

```bash
cd data/db
psql --command "CREATE DATABASE fisumwelt;"
psql -d fisumwelt --command "CREATE EXTENSION postgis;"
psql -d fisumwelt --command "CREATE USER auikadmin with password 'secret';"
psql -d fisumwelt --command "ALTER USER auikadmin with superuser;"
psql -d fisumwelt -f version1_0_schema.sql
psql -d fisumwelt -f updateTo_1_1_0.sql
psql -d fisumwelt -f import_csv.sql
```

Vor dem Starten der Anwendung muss in der `auik.properties` der Eintrag `auik.system.dburl` gesetzt werden um die Verbindung mit der Datenbank zu ermöglichen.

Beispielweise mit einer Datenbank erreichbar unter `localhost:15432` mit dem Datenbank-Namen `fisumwelt`:

```
auik.system.dburl=jdbc\:postgresql\://localhost\:15432/fisumwelt
```

Für die Anwendung selbst müssen `maven` und ein passendes JDK ab Version 11 (bspw. OpenJDK 11) installiert sein.

Kompilieren und Starten der Anwendung:

```bash
mvn clean compile exec:java
```

Erstellen eines Jar-Archivs:

```bash
mvn clean package
```
Das Archiv ist im Ordner `target` zu finden.

0 comments on commit 2d01141

Please sign in to comment.