annotate README.markdown @ 726:a5c755b0cfda

Filter the group string. This should be tidied...
author Dustin Demuth <dustin@intevation.de>
date Tue, 25 Aug 2015 10:49:31 +0200
parents 60cc9b5126d1
children 6a24f01bdaac
rev   line source
716
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
1 Lada-Server
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
2 ===========
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
3 Die Software bietet Funktionalität zur Erfassung und Bearbeitung
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
4 von Messdaten. Sowie der Planung der Messungen.
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
5
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
6 Weitere Informationen finden sich auf der Projektwebseite unter
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
7 der Adresse: https://wald.intevation.org/projects/lada/
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
8
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
9 Die Software entstand im Rahmen einer Software Entwicklung durch die
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
10 Intevation GmbH im Auftrag des Bundesamt für Strahlenschutz in den Jahren 2013
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
11 bis 2015.
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
12
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
13 Kontakt
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
14 -------
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
15 Bundesamt für Strahlenschutz
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
16 SW2 Notfallschutz, Zentralstelle des Bundes (ZdB)
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
17 Willy-Brandt-Strasse 5
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
18 38226 Salzgitter
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
19 info@bfs.de
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
20
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
21 Lizenz
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
22 ------
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
23 Die Software ist unter der GNU GPL v>=3 Lizenz verfügbar.
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
24 Details siehe die Datei `COPYING`.
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
25
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
26 Quelltext
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
27 ---------
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
28 Die Quelldateien lassen sich wie folgt auschecken:
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
29 ```
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
30 hg clone https://scm.wald.intevation.org/hg/lada/lada-server
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
31 ```
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
32
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
33 Entwicklung
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
34 -----------
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
35 Für die Entwicklung wird ein JDK7 und maven3 oder höher benötigt. Sämtliche
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
36 Abhängigkeiten werden von dem maven build System aufgelöst.
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
37
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
38 Installation
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
39 ------------
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
40 Zur Installation der Lada-Anwendung müssen folgende Schritte unternommen werden:
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
41
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
42 $ mvn clean compile package
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
43 $ cd /opt/wildfly8.2.Final/standalone/deployments
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
44 $ cp /path/where/the/war/file/is/lada-server.war .
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
45 $ touch lada-server.war.dodeploy
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
46
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
47 Zum Aktualisieren der Anwendung genügt es, wenn die lada-server.war Datei aktualisiert
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
48 wird.
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
49
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
50 Die Anwendung ist dann unter dem Pfad "/lada-server" (abhängig vom Archivnamen)
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
51 erreichbar.
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
52
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
53 Tests
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
54 -----
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
55 Die auf Arquillian basierenden Tests erfordern einen vollständig konfigurierten
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
56 und gestarteten Wildfly Application-Server, da für die Schnittstellentest eine
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
57 Clientanwendung simuliert wird und HTTP-Requests ausgeführt werden.
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
58
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
59 Das Ausführen der Tests erfolgt durch das Kommando
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
60
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
61 $ mvn -Premote-test clean test
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
62
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
63 Dokumenation
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
64 ------------
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
65 Die Entwicklerdokumentation (Javadoc) kann mit dem folgenden Befehl im
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
66 Verzeichnis der Serveranwendung erzeugt werden:
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
67
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
68 $ mvn javadoc:javadoc
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
69
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
70 Der Ordner 'target' enthält dann die Dokumentation im HTML-Format in dem
60cc9b5126d1 Added README file.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
71 Verzeichnis 'site/apidocs'.
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)