Developer Setup

Developer Setup

Install and Configure Eclipse

• Download Eclipse from http://eclipse.org/downloads/. We recommend getting the Eclipse IDE for Java EE Developers version.
• Launch Eclipse. The first time it runs, it will prompt you to choose a workspace location.
• Install Git support
  • In Eclipse, select Help->Install New Software....
  • In the Work with dropdown, select the Helios link.
  • In the text box below the dropdown, enter "git" to filter the available software.
  • Click on the checkbox next to Eclipse EGit.
  • Click on Next> and follow the prompts to install the component.

Pull down source

Follow this tutorial to retrieve the Maqetta source from GitHub into your Eclipse workspace.

If cloning as read-only, use the URI git://github.com/maqetta/maqetta.git. The Clone Git Repository window should look like this:

Committers who need read/write access should use the URI git@github.com:maqetta/maqetta.git and set the connection protocol to ssh.

After cloning the repository, make sure the Import Existing Projects radio button is set, click Next>, then Select All to select the projects to import. Click Finish.

Set up and launch the Maqetta server

1. Maqetta requires a workspace location on the local file system. The launch configurations look for an environment variable called MAQETTA_WORKSPACE.

   • for Windows set this in the environment variables section under System Settings
   • for OSX users, you must add the following line to /etc/launchd.conf (~/.profile won't work): setenv MAQETTA_WORKSPACE /yourMaqettaWorkspaceLocation

2. Open the launch configurations by clicking the drop-down arrow next to either of the launch options (debug or regular) and selecting "debug configurations"

3. Locate the various maqetta launch configurations. There is a single user mode (no user authentication) or a server/multi user mode that requires registration.

4. (OPTIONAL) In the "Arguments" tab, look for the "VM Arguments" text area:

   • Chose a port other than 80 (e.g., 55555):
     • Edit "-Dorg.eclipse.equinox.http.jetty.http.port=8080" (or 55555)
     • Note: 8080 is a fairly common port number. To minimize conflict, pick a port number between 50000 and 59999, such as 55555.

5. (OPTIONAL) (prefer to set with env. variable from step #1) set the user files directory (current dir will be used if not set) to tell Maqetta where to write users' created applications : * Edit "-Dmaqetta.baseDirectory=/path/into/which/maqetta/writes/its/output/files"

6. Run the launch configuration:

   • Click on the Run button.
   • In the Eclipse console, you should see an "osgi>" prompt. At that point, the Eclipse server is running and browsers can navigate to this server (see instructions in next section)
   • If you need to terminate the server, click on the red square in the Eclipse console view.

Load Maqetta in a browser

In a web browser, load http://localhost/maqetta (or http://localhost:55555/maqetta or whichever port you selected above).