Quickstart Guide

Vorraussetzungen

GitHub bietet für jeden Entwickler mit Github Account die Möglichkeit direkt an der Entwicklung teil zu nehmen. Beachtet werden sollte hier, dass es zuerst am wichtigsten ist MediathekView zu stabilisieren und zu Verbessern. Erst dann sollten wir uns um neue Features kümmern. Ein guter Einstieg ist das Bearbeiten von Issues. Außerdem sollte man daran denken, dass man als Entwickler nicht alleine ist und deshalb mit den anderen Entwicklern, z.B. durch Kommentare in den Issues, kommunizieren sollte. Auch ein regelmäßiges committen und pushen des jeweiligen lokalen branch Standes sollte regelmäßig durchgeführt werden so, dass andere Entwickler an der entsprechenden Stelle weiter machen können. Über commit Kommentare kann auf besonderheiten der Änderung so wie dem geplanten weiteren Verlauf verwiesen werden.

Allgemein

• IDE: Eclipse (empfohlen) / Netbeans / IntelliJ
• • Eclipse Download: https://eclipse.org/

Windows

• Oracle JDK 8: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
• Git: https://git-scm.com/

Linux

• Oracle JDK 8: https://wiki.ubuntuusers.de/Java/Installation/Oracle_Java/Java_8/
• Git: https://wiki.ubuntuusers.de/Git/

Alternative Cloud Umgebung

Es ist auch möglich in der Cloud zu arbeiten. Hier ein dafür verwendbares Docker file: https://raw.githubusercontent.com/Nicklas2751/Dockerfiles/master/ubuntu_oracle-jdk8-newest_gradle/Dockerfile

Dies kann z.B. hier verwendet werden: https://codenvy.io

Git Vorbereitungen

Zuerst sollten wir die drei Hauptprojekte auschecken (Die Platzhalter in den eckigen Klammern müssen angepasst werden):

git --gloabl user.name "[Username]"
git --global user.email "[Mail-Adresse]"
git clone https://github.com/mediathekview/MSearch.git
git clone https://gitthub.com/mediathekview/MServer.git
git clone https://github.com/mediathekview/MediathekView.git

Import in die einzelnen IDES

Eclipse

In Eclipse wird für Gradle das folgende Plugin benötigt: http://projects.eclipse.org/projects/tools.buildship

Pro Projekt (mindestens MSearch (lib) + MServer oder MediathekView):

1. Datei -> Import -> Gradle
2. Projekt Ordner als "Root Project Folder" auswählen
3. Weiter -> warten -> "Finish"

Weitere Informationen zur Gradle Integration: https://gradle.org/eclipse/

Netbeans

In Netbeans wird folgendes Plugin für Gradle benötigt: http://plugins.netbeans.org/plugin/44510/gradle-support

1. Datei -> Projekt öffnen ...
2. Im Projekt öffnen Dialog den Ordner welcher die mit git geklonten Projekte beinhaltet öffnen
3. Alle MediathekView Projekte mit gedrückter Strg Taste auswählen (für Mac: Command statt Strg)
4. Projekt öffnen

InteliJ

InteliJ liefert von Haus aus eine Gradle integration mit. Diese muss allerdings evtl erst noch aktiviert werden.

Anschließend kann das MediathekView Projekt als Gradle Projekt importiert werden. Die Projekte MSearch und MServer können als Modul in dieses Projekt importiert werden.

[TODO Ausführliche Anleitung zum importieren @Nicklas2751]

Erster Build mit der IDE

Eclipse

Pro Projekt:

1. Gradle Tasks
2. Projekt -> "build" -> "build"

Netbeans

Netbeans erkennt dank dem gradle Plugin wie das Projekt gebaut wird.

Zum bauen:

1. Rechtsklick auf das Projekt MediathekView
2. Build

IntelliJ

Ausführen von Gradle

Windows

Unter Windows können Gradle befehle so ausgeführt werden: [ProjektOrdner]/gradlew.bat [Befehle] Um den Rest wie das runterladen von Gradle kümmert sich der Wrapper.

Linux

Unter Linux können Gradle befehle so ausgeführt werden: [ProjektOrdner]/gradlew [Befehle] Um den Rest wie das runterladen von Gradle kümmert sich der Wrapper.

Ausführen der Applikation

Eclipse

1. Package "mediathek" aufklappen
2. Rechtsklick auf Main.java
3. Run As -> Java Application

Netbeans

1. Rechtsklick auf das Projekt z.B. MediathekView
2. Run

IntelliJ

Gradle

Im MediathekView Projekt ist ein task run hinterlegt dieser startet die Applikation. Dieser kann wie folgt gestartet werden: ./gradlew run (Linux) gradlew.bat run (Windows)

Start Argumente übergeben

Netbeans

1. Projekt -> Recktsklick -> Eigenschaften -> Built-In Tasks
2. "Run" auswählen
3. Inerhit abwählen
4. Arguments: -Pargs=arg1,arg2,arg3 (Die Vorbelegung ersetzen)
5. Ok
6. Projekt -Rechtsklick -> Run

Gradle / Konsole

• gradlew run -Pargs=arg1,arg2,arg3

Debuggen der Applikation

Eclipse

Netbeans

1. Rechtsklick auf das Projekt z.B. MediathekView
2. Debug

IntelliJ

Gradle + Debugger

Im MediathekView Projekt ist ein task debug hinterlegt dieser startet die Applikation für einen Debugger auf dem Port 5005. Dieser kann wie folgt gestartet werden: ./gradlew debug (Linux) gradlew.bat debug (Windows)

Wenn dieser das Projekt soweit gebaut hat und gestartet ist Zeigt er an, dass er nun auf Port 5005 lauscht. Auf diesen Port kann sich nun mit einem Debugger verbunden werden. Die IDEs bringen diese funktionalität auch mit.

Verbinden mit Eclipse

Verbinden mit Netbeans

Der Debug von Netbeans nutzt automatisch die Debug socket verbindung.

Ansonten sollte z.B. der Projekt auf einem anderen Gerät im debug gestartet sein und man möchte sich verbinden:

1. Debuggen -> Debugger anhängen...
2. Port und host eintragen
3. Ok

Verbinden mit IntelliJ

Start Argumente übergeben

Netbeans

1. Projekt -> Recktsklick -> Eigenschaften -> Built-In Tasks
2. "Debug" auswählen
3. Inerhit abwählen
4. Arguments: -Pargs=arg1,arg2,arg3 (Die Vorbelegung ersetzen)
5. Ok
6. Projekt -Rechtsklick -> Debug

Gradle / Konsole

• gradlew debug -Pargs=arg1,arg2,arg3