Skip to content
This repository has been archived by the owner on Jul 2, 2018. It is now read-only.

Development

Jump to bottom
Natasa Bulatovic edited this page Jul 26, 2016 · 4 revisions

Install Java

imeji supports java 8. Compatibility with Java 7 or previous versions is not guaranteed:

Install Eclipse

For the development, we encourage to use the Eclipse IDE for JEE developers:

Install Maven

imeji uses Maven:

Install Application Server

imeji needs an application server to run. Currently it supports  **Tomcat **and **_JBoss _**application servers.

Tomcat

Import Tomcat in Eclipse

  1. Open Eclipse
  2. On the top menu, select Window -> Show View -> Server (If server is not displayed, select Other and then Server)
  3. Right click in the Server View, select New -> Server
  4. Select Apache -> Tomcat v7.0 and click Finish (or Next if you want to change the default ports)

Configuration

  • Edit web.xml connectors with URIEncoding attribute, as following: <Connector URIEncoding="UTF-8"/>  

JBoss

Import JBoss in Eclipse

  1. Open Eclipse
  2. Since Jboss 7 is not in last default Eclipse, you need to import the Jboss plugin: On the top menu, select Help -> Eclipse Marketplace. Search for Jboss. Install either JBoss Tools or JBoss developer studio.
  3. On the top menu, select Window -> Show View -> Server (If Server is not displayed, select Other and then Server)
  4. Right click in Server View, select New -> Server
  5. Select JBoss -> JBoss 7 and click finish (or next if you want to change the default ports)

Config

  • Edit standalone.xml with (after the extensions):

Download imeji sources

The imeji code source is hosted at Github. We recommend to use the official Github client:

Clone imeji on Windows

After having installed the Github client for Windows, go on imeji Github page and click on "clone in Windows".

Import imeji in Eclipse

  1. Open Eclipse
  2. Click on top menu "File"
  3. Select Import
  4. Select Maven: Existing Maven Project and click on next
  5. Browse file system, select the imeji directory and click Finish

Install jRebel

jRebel is tool enabling automatic "hot deploy" to avoid to redeploy of your application on the server for each change. It can be downloaded here. To install it:

  1. Unzip jRebel, and copy it somewhere in your computer
  2. Add the license file in the jrebel_home directory (see also the note below)
  3. Add it to your server (Server -> double click on Server -> Open launch configuration -> Arguments) (replace JREBEL_HOME_PATH with your local path): 1. for Tomcat: 
    -javaagent:JREBEL_HOME_PATHjrebel.jar
    2. for JBoss: 
    -noverify -javaagent:JREBEL_HOME_PATHjrebel.jar
  4. Check: that server Publishing is set on Never publish automatically and that imeji is build automatically (top menu  Project -> Build automatically) Note: jRebel is free for open source development. Ask for a license at http://zeroturnaround.com/.

Compile imeji

  • Make sure property files are in place:
    • Tomcat: TOMCAT_HOME/conf
    • JBoss: JBOSS_HOME/standalone/configuration
  • Compile imeji with
mvn clean install
  • Deploy the files
    • For Tomcat users: Copy generated imeji.war file in the TOMCAT_HOME/webapps
    • For JBoss users: Compile ear: clean install jboss-as:deploy (use then jboss-as:redeploy)
  • Start your application server (follow the application server specific instructions)
  • imeji is available at http://localhost:8080/imeji/ (the port :8080 depends on your configuration, Apache server can be used to hide the port in the url)
  • If you want to use the Fledged Data Service you need to adapt the fds.properties

Install imeji under Arch Linux

A manual can be found here.

Clone this wiki locally