DeveloperSetup

Developer Setup

Welcome to the ERNST project. Please edit and update this Developer Setup checklist wiki as you work through it so that this wiki page becomes more detailed each time someone new joins the project.

1. Request addition to the project

   • Create a SourceForge.net account
     • https://sourceforge.net/user/registration
   • E-mail the username to one of the project Administrators

2. Read the Java coding style guidelines

   • You do not have to follow these guidelines to contribute
   • http://www.croftsoft.com/library/tutorials/java-style-guide/

3. Install the Java 7 SDK

   • ...

4. Install Maven

   • ...

5. Read the online Subversion book

   • Read at least the first two chapters
   • http://svnbook.red-bean.com/

6. Check out the project from the command line

   • Log in to SourceForge.net
   • Go to the command prompt (bash, Cygwin, DOS)
   • Enter the developer-specific read-write (RW) Subversion checkout command
     • https://sourceforge.net/p/ernst/code/37/tree/
     • When prompted, enter your SourceForge.net password twice

7. Build and test the project from the command line

   • cd ernst-code/mvn
   • mvn clean install

8. Install Eclipse

   • http://eclipse.org/downloads/
   • Choose "Eclipse IDE for Java EE Developers"
   • For Ubuntu, we strongly recommend that you install Eclipse from the web site instead of installing the Ubuntu version. The Ubuntu version is not fully compatible with the Subeclipse or m2e Maven plugins.

9. Install Subclipse plugin for Eclipse

   • http://subclipse.tigris.org/servlets/ProjectProcess?pageID=p4wYuA
   • On Windows, install SVNKit but not JavaHL Native Library Adapter to avoid SSH complications

10. Install m2eclipse Maven plugin for Eclipse

    • http://eclipse.org/m2e/download/

11. Check out the ernst-code project within Eclipse at the trunk level

    • This will create generic project within Eclipse
    • File / New / Other... / SVN / Checkout Projects from SVN / Next
    • Checkout from SVN / Select/Create Location / Create a new repository location: checked
    • Next
    • Checkout from SVN / Select/Create Location / Location / Url: svn+ssh://[username]@svn.code.sf.net/p/ernst/code
    • Next
    • Checkout from SVN / Select Folder / trunk
    • Next
    • Checkout from SVN / Check Out As / Finish
    • New Project / Select a wizard / General / Project
    • Next
    • New Project / Project / Project name: ernst-code
    • Finish
    • Note: on operating systems other than Windows, you may be prompted to install JavaHL, a Java languaged binding for the Subversion API. You may need to then uninstall Subclipse and install an earlier version that matches with your JavaHL version (as described here: http://arobenko-tech.blogspot.com.au/2012/07/getting-subclipse-to-work-with-ubuntu.html).

12. Check out the ernst-code project within Eclipse at the trunk/mvn level

    • This will create a separate Maven project in Eclipse
    • File / New / Other... / Maven / Checkout Maven Projects from SVN
    • In the drop-down menu, select "svn"
    • SCM Url: svn+ssh://[username]@svn.code.sf.net/p/ernst/code/trunk/mvn
    • Next

13. ...

    • ...

14. Java may give compilation errors due to @override annotations used to mark implementations of interface methods. If this happens, it's because you are building with JRE version 1.5 (Java 5) or earlier. Right click on the JRE library to remove it from your build path. Then right click on your project and click "Properties" -> "Build Path" -> "Configure Build Path" -> "Libraries" -> "Add Library" -> "JRE System Library" -> "Workspace default JRE."

    • ...

15. Read the Developer documentation

    • http://sourceforge.net/p/ernst/code/37/tree/trunk/doc/
    • http://ernst.sourceforge.net/apidocs/