Edit me

The Communote core is a Java servlet based web application which can be extended with plugins (OSGi bundles). This page describes what you need to do to setup your development environment to build the Communote core and Communote plugins.

1.1 Setup Java and Maven

For building Oracle’s JDK 8 and a current version of Maven 3 needs to be installed. To test whether the correct JDK is already available you can open a command prompt and run the following command which should output the installed version.

javac -version

If you don’t have the JDK you can get it from Oracle’s download page. In a similar fashion you can check if Maven is already setup correctly:

mvn --version

This should print the version of the installed Maven and the version of Java Maven is going to use. If Maven is still missing you can follow the instructions at the Maven homepage to set it up.

1.2 Configure Maven

For building plugins against a specific Communote release (without compiling the core of that version) you have to add the Communote Maven repository to your settings.xml:

<repository>
    <id>bintray-communote-maven</id>
	<name>bintray</name>
    <url>http://dl.bintray.com/communote/maven</url>
	<releases>
        <enabled>true</enabled>
    </releases>
    <snapshots>
        <enabled>false</enabled>
    </snapshots>
</repository>

This snipped can be added to the repositories element of an existing or new profile element (see Maven documentation for details).

Since most of Communote’s dependencies are available in the Maven central repository you can insert its definition into the same repositories element right before Communote’s repository definition. This can speed up the build because Maven will then check the central repository first. The XML snippet looks like this:

<repository>
    <id>maven-central</id>
    <name>Maven Central Repository</name>
    <url>http://repo1.maven.org/maven2/</url>
    <releases>
        <enabled>true</enabled>
    </releases>
    <snapshots>
        <enabled>false</enabled>
    </snapshots>
</repository>
Tags: development