Imeji Developer environment

From MPDLMediaWiki
Jump to navigation Jump to search

Template:Imeji

This page describes how to develop the imeji software

Introduction[edit]

The imeji software is developed and supported by the imeji community. If you want to participate to the project, please contact the community: mailto:imeji-community@gwdg.de.

Install Java[edit]

imeji supports java 6. Compatibility with Java 7 is not guarantee:

Install Maven[edit]

imeji use Maven 2.2.1:

Install Eclipse[edit]

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

Download source[edit]

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

Clone imeji on Windows[edit]

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

Import imeji in Eclipse[edit]

  1. open Eclipse
  2. Click on top menu "File"
  3. Select Import
  4. Select Maven: Existing Maven Project and click on next
  5. Browse filesystem en select imeji directory and click on Finish

Compile imeji[edit]

  • Set credentials in your settings.xml of maven (for actual values, please contact [1]):

<properties>
  <jboss.install.dir>YOUR_JBOOS_PATH</jboss.install.dir>
  <escidoc.framework_access.framework.url>YOUR_CORESERVICE_URL</escidoc.framework_access.framework.url>	
  <imeji.tdb.path>YOUR_JENA_DIRECTORY</imeji.tdb.path> 
  <imeji.sysadmin.email>admin_email</imeji.sysadmin.email>
  <imeji.sysadmin.password>a_password</imeji.sysadmin.password>
  <imeji.escidoc.user>an_escidoc_user</imeji.escidoc.user>
  <imeji.escidoc.password>a_password</imeji.escidoc.password> 
  <framework.admin.username>coreservice_admin_login</framework.admin.username>
  <framework.admin.password>password</framework.admin.password>
  <imeji.email.server.smtp>YOUR_MAILSERVER</imeji.email.server.smtp>
  <imeji.email.user>mailserver_user</imeji.email.user>
  <imeji.email.password>mailserver_pwd</imeji.email.password>
  <imeji.email.auth>true/false</imeji.email.auth>
  <imeji.email.sender>sender_adress</imeji.email.sender>
</properties>

  • Check properties in "meta" pom.xml
    • Attention: Some properties are related to the core service. If you install your own core service, you will have to adapt it. Please check the eSciDoc core service page. For problems with the core service please contact the eSciDoc developer mailing list
    • For more information about the properties see the imeji properties page
  • If you want to use the Fledged Data Service you need to adapt the fds.properties
  • Compile presentation: clean install
  • Compile ear: clean install jboss:harddeploy
  • Start your server
  • imeji is available at http://localhost:8080/imeji/