Yale Bedework Project - Development Environment Setup

Summary

This wiki page describes how to configure your development environment so that is suitable for doing software development on the Yale Events Calendar project. Once the steps in this guide are completed, you should have the ability to make changes to the software, build, and commit those changes back to SVN.

Install and Configure

Development Tools

Download and install the following development tools:

Note: since it can be difficult to find old versions of the JDK, the above link is a Windows version of JDK1.5

We use JDK 1.6 to run Eclipse, but we compile using JDK 1.5. The MySQL Tools are optional, but might be helpful to inspect the MySQL database.

Configuration Guide

Now that you have all of the software downloaded and installed, there is some configuration to perform. The following steps should set you up.

Create an Eclipse Shortcut

Once Eclipse is installed, I recommend creating a shortcut (or the unix equiv.) with the following additional command line parameters:

-vm C:\path\to\jdk16\bin -data C:\path\to\workspace-folder -vmargs -Xms256M -Xmx1024M -XX:MaxPermSize=128M

This will force Eclipse to use your 1.6 JDK as the runtime (which is necessary for m2eclipse to work properly). Additionally, Eclipse will not prompt you for your workspace folder - it will simply use the one supplied on the command line. Finally, some memory settings are included to ensure you don't run out.

Configure JDK 1.5 in Eclipse

1. Launch Eclipse
2. Open the preferences via Window->Preferences
3. Under Java->Installed JREs add your 1.5 JDK (Standard VM)
4. Make the 1.5 JDK the default

Check Out from SVN

1. Switch to the SVN Repository Exploring perspective in Eclipse
2. In the SVN Repositories view add the calendar repository at the following URL:
   • https://svn.its.yale.edu/repos/eventCalendar
3. Right-click on yale-bedework/trunk and choose Check out as Maven Project...

   Yale Bedework App Source Checked Out

   You have now officially checked out the Yale Bedework project source code. Please see YaleBedeworkArchitecture for more details about the project. You should now see a number of projects in your workspace that all start with yale-bedework. It will take some time for Eclipse to checkout, configure, and build all of these projects so please be patient.

Build the Yale Bedework App
Even though Eclipse has already compiled all of the Yale java code, Bedework itself (and as a result the overall application) has not yet been built. That is controlled by a Maven + Ant build. For more details please see Architecture. Next, we need to ensure that the full build of the application succeeds.

1. In Eclipse, open the file yale-bedework-vendor/build.properties and following the instructions therein
2. Run the included Eclipse launch labeled yale-bedework - package (may take several minutes)
   1. From the Run menu select Run Configurations...
   2. Expand Maven Build in the tree on the left
   3. There should multiple launches including yale-bedework - install (local) and yale-bedework - package
   4. Select the yale-bedework - package launch
   5. Click Run

      Yale Bedework App Built!

      Assuming the Maven build completes successfully, you have just successfully built the Yale Bedework Application. The output (artifact) of the build is a .zip file in the yale-bedework/target directory. Note that the newly built application has not been deployed to your JBoss server.

Install the Yale Bedework App
Assuming that the above build completed successfully, you'll probably want to install what you've built into your local Maven repository (so that it can be deployed to your local JBoss runtime environment). To build and then install the Yale Bedework application to your local Maven repository, follow the steps in the above section, but choose yale-bedework - install (local).