Skip to content

Latest commit

 

History

History
67 lines (41 loc) · 3.09 KB

README.md

File metadata and controls

67 lines (41 loc) · 3.09 KB
Raw

iDAI.gazetteer

In dem Projekt befinden sich sowohl Frontend als auch Backend-Code. Als IDE empfiehlt sich STS. Außerdem werden lokale Instanzen von MongoDB und Elasticsearch benötigt.

Setup

Import des Github Repos in IDE

STS

Das Projekt kann über File -> Import -> Maven -> Existing Maven Project in STS importiert werden und kann nach Auflösen der Dependencies mit Run As -> Run on Server gestartet werden. Danach ist der Gazetteer unter http://localhost:8080/gazetteer erreichbar.

IntelliJ

Das Projekt kann in IntelliJ über File -> New -> Project from Version Control -> Github importiert werden.

Einbinden von Java JDK: Unter "File -> Project Structure... -> Plattform Settings -> SDK -> Add New SDK -> Java SDK" muss das Verzeichnis der Java SDK Installation angegeben werden. Unter Mac ist dies z.B. "/Library/Java/JavaVirtualMachines/jdk1.8.0_101.jdk/Contents/Home".

Einbinden von Tomcat: Unter "Preferences -> Build, Execution, Deployment -> Application Servers -> Add Apllication Server -> Tomcat Server" kann das Verzeichnis einer binären Distribution von Tomcat angegeben werden.

Konfiguration: Hauptanwendung (Java/Tomcat)

Vor dem Start muss sichergestellt werden, dass die nötigen Konfigurationsdateien vorhanden sind:

  • src/main/resources/log4j.xml
  • src/main/webapp/WEB-INF/web.xml
  • src/main/webapp/WEB-INF/config.properties
  • src/main/webapp/WEB-INF/elasticsearch.properties
  • src/main/webapp/WEB-INF/mail.properties (optional, bei fehlender Mail-Konfiguration werden keine Mails versandt)

In den entsprechenden Ordnern befinden sich Template-Files, die eine Grundkonfiguration bereitstellen. Vor dem Start sollten die Templates umbenannt bzw. kopiert und evtl. angepasst werden. z.B. Anpassen des Speicherpfades der Logdatei, da ggfs. in template Pfad keine Schreibrechte vorliegen. In src/main/resources/log4j.xml:

<appender name="file" class="org.apache.log4j.DailyRollingFileAppender">
   <param name="file" value="/Users/[USERNAME]/gazetteer.log" />

Indizierung

Eine Elasticsearch-Reindizierung kann bei laufendem Gazetteer über die Admin-API angestoßen werden:

curl -XPOST user:password@localhost:8080/gazetteer/admin/reindex

Dazu muss ein Useraccount verwendet werden, der über Adminberechtigungen verfügt.

Architektur

Backend (Java/SpringMVC) und Frontend (Javascript/AngularJS) werden im gleichen Projekt verwaltet. Der Quellcode des Backends liegt unter src/main/java, der des Frontends unter src/main/webapp/resources/js. Die AngularJS Views werden durch JSPs generiert und liegen unter src/main/webapp/WEB-INF/views/html/partials. Zusätzlich liegen unter src/main/scripts einige in Ruby geschriebene Skripte für den Im- und Export für spezifische Projekte.

i18n

Übersetzungen werden in den Dateien src/main/resources/messages.properties_ und src/main/webapps/resources/js/i18n/messages.js_ (Frontend) vorgenommen.

Deployment

Das WAR-File kann mit folgendem Befehl erstellt werden:

mvn clean package

Das resultierende Web-Archiv kann dann in einem beliebigen Servlet-Container deployt werden.