Skip to content

Latest commit

 

History

History
232 lines (145 loc) · 6.03 KB

howto-start-development-with-eclipse.rst

File metadata and controls

232 lines (145 loc) · 6.03 KB
Raw

How To Start Development With Eclipse

Author

Manuel Rego Casasnovas

Contact

rego@igalia.com

Date

16/12/2011

Copyright

Some rights reserved. This document is distributed under the Creative Commons Attribution-ShareAlike 3.0 licence, available in http://creativecommons.org/licenses/by-sa/3.0/.

Abstract

Quick guide to start the development of LibrePlan using Eclipse IDE. As this is the most common way of work among LibrePlan developers team.

Table of Contents

Download LibrePlan source code

You need to download LibrePlan source code to start hacking on it. You have two options:

  1. Clone Git repository (recommended):

    $ git clone git://github.com/Igalia/libreplan.git

  2. Download last version source code:

    $ wget http://downloads.sourceforge.net/project/libreplan/LibrePlan/libreplan_1.2.0.tar.gz
$ tar -xzvf libreplan_1.2.0.tar.gz

You should review HACKING file to check that you have installed all the requirements.

Download Eclipse Java EE

Eclipse downloads webpage

Eclipse downloads webpage

Install Ecliplse

  • Go to /opt/ (or any other folder when you want to install Eclipse):

    # cd /opt/

  • Uncompress downloaded file and set proper permissions:

    # tar -xzvf ~/Downloads/eclipse-jee-indigo-SR1-linux-gtk-x86_64.tar.gz
# chown -R root:root eclipse/

  • Add symbolic link to launch Eclipse:

    # cd /usr/local/bin/
# ln -s /opt/eclipse/eclipse

Install Eclipse Maven plugin (m2e)

  • Run Eclipse:

    $ eclipse
  • Choose your workspace folder (or accept the default one) and mark to don't ask about it again
  • Go to Help > Install New Software...
  • Click in option Add and set the following values and click Ok:
  • Click Next to install plugin

Install Eclipse Maven plugin (m2e)

Install Eclipse Maven plugin (m2e)
  • Accept license agreements and click Finish
  • Restart Eclipse once plugin installation has finished

Import LibrePlan project

  • Go to File > Import
  • Select as import source Maven > Exising Maven Projects and click Next

Import LibrePlan as Maven project

Import LibrePlan as Maven project
  • Set as Root Directory the path where you downloaded LibrePlan source code
  • Then mark all projects and click Finish

Import LibrePlan from existent path

Import LibrePlan from existent path
  • It is recommended to close libreplan project (right click over the project and choose Close)

Configure project to run

  • Go to Run > Run Configurations...
  • Create a new Maven Build called New_configuration
  • Change the following values:
    • Name: LibrePlan
    • Base directory: Choose libreplan-webapp folder in your workspace
    • Goals: jetty:stop jetty:run
    • Profiles (optional): -userguide,-reports,-i18n (to disable userguide, reports and i18n profiles to save compilation time as they are not mandatory to run LibrePlan)
    • Mark the following checkboxes (recommended):
      • Resolve Workspace artifacts
      • Update Snapshots
      • Skip Tests

Configure how to run LibrePlan in Eclipse

Configure how to run LibrePlan in Eclipse

Configure Maven profiles

  • For each opened project in the Project Explorer (ganttzk, libreplan-business, libreplan-webapp) configure Maven profiles to save compilation time (this is not mandatory):
    • Right click over the project and go to Properties
    • Look for Maven and set Active Maven Profiles: -userguide,-reports,-i18n

Project properties window

Project properties window

Configure Eclipse to follow coding style guidelines

  • Go to Window > Preferences
  • Look for the different options to use always spaces instead of tabs and use 4 spaces size for indentation

Eclipse Preferences window

Eclipse Preferences window
  • Create new profile to follow the coding style guidelines

New profile based on Eclipse default one

New profile based on Eclipse default one
  • Configure Save Actions marking the following options:
    • Perform the selected actions on save
    • Format source code
    • Format edited lines
    • Organize imports

Save Actions configuration

Save Actions configuration

Develop LibrePlan in Eclipse using MySQL

  • This tutorial works properly with PostgreSQL, but if you want to develop LibrePlan using MySQL you have to do 2 small changes:
  • Remember that the three last profiles that are being disabled is just to save compilation time and not mandatory. However, to develop using MySQL you have to set at least the first two: dev and mysql.