Getting Started

The instructions on this page will get you to the point where you can run WPI Suite TNG's components locally and start developing.

Install Eclipse and Required Plugins

The easiest way to work with WPI Suite TNG is to use Eclipse, which can be configured to run the client and server with the click of a button.

Indigo or Juno should work fine as of this writing
Eclipse for Java EE will include some other prerequisites, but these can be installed as plugins from within Eclipse Classic.

Open Eclipse
Click on Help > Install New Software
Choose the update site in the drop down for your Eclipse release (e.g. http://download.eclipse.org/releases/indigo/)
Install the following plugins:

Install Java 7 if you haven't already (the Core uses JDK 7, but still compiles to Java 6)

On Ubuntu, the simplest way of doing so is sudo apt-get install openjdk-7-jdk
On OS X, follow these installation instructions for installing the JDK 7 from Oracle
TODO: Windows instructions

You may need to tell Eclipse where Java 7 is installed:
In Eclipse, select Window > Preferences > Java > Installed JREs
Click "Add", choose "Standard VM", and click "Next"
Type in the JRE home of the JDK you just installed * Linux is usually at /usr/lib/jvm/some-directory-in-here * OSX is likely /Library/Java/JavaVirtualMachines/jdk/Contents/Home * TODO: Windows path
Make sure the system libraries appear in the list box and click "Finish"

In order to develop effectively, you will need to clone WPI Suite TNG's Git repository onto your machine, make commits to it, and push to GitHub.

Install Git
Open up a terminal (or Git Bash on Windows)
Navigate to a directory you want your repository to live in (e.g. ~/Projects/SoftEng)
Run git clone git@github.com:fracture91/wpi-suite-tng.git to clone the repository (e.g. into ~/Projects/SoftEng/wpi-suite-tng)

Don't clone directly into your eclipse workspace! This can lead to accidentally committing files you shouldn't be committing. A subdirectory in your eclipse workspace is less likely to break, but still has other problems (e.g. cd eclipse-workspace && git clone git@github.com:fracture91/wpi-suite-tng.git). See this page for more information.

6.Install DB4.o by adding the DB4.o jar as an external JAR in Eclipse

The server component of WPI Suite TNG runs on a Tomcat server, which you will need to configure to run with Eclipse.

Installing Tomcat on Ubuntu
1. Install Tomcat 7 (with sudo apt-get install tomcat7 or from [this downloads page (http://tomcat.apache.org/download-70.cgi))
Installing Tomcat on OS X
1. The easiest way is to use the homebrew package manager, if you don't have it you can get it by running this command ruby -e "$(curl -fsSkL raw.github.com/mxcl/homebrew/go)"
2. Do brew doctor to verify brew is installed correctly
3. Run brew update to update your local repository
4. Run brew install tomcat to install Tomcat 7 (see these instructions for more help)
This page has instructions for getting Tomcat to work with Eclipse. Note that the install directory will vary based on your operating system.
- Do step 4 and make sure you choose your Java 7 JRE along the way
- Steps 6 through 10 may be necessary if you encounter the mentioned errors (we've encountered them on Ubuntu 12.04 and OSX 10.8)
- Do steps 11 and 12 to create a server in Eclipse
- Do step 13 to keep Tomcat from running at startup (or accomplish the equivalent on your operating system)
- You will need to also copy the DB4o JAR into the lib directory of your tomcat download so that Tomcat will understand the DB4o commands being used.

At this point, all projects should now be free of any errors.

You may want to continue reading about the Project Layout or Running WPI Suite TNG Locally.