comparison README.markdown @ 716:60cc9b5126d1

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