Developer Setup

jhpedemonte edited this page Nov 15, 2012 · 30 revisions

Developer Setup

This page is obsolete. Instead, use these instructions: Maqetta-with-Orion-Developer-Setup

Install and Configure Eclipse

  • Download Eclipse from 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 Juno (or Indigo or Helios, if you are using an older version of Eclipse; the URL should look something like
    • 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:// The Clone Git Repository window should look like this:

Committers who need read/write access should use the URI and set the connection protocol to ssh.

When specifying the Local Destination, it is advised that you check the Clone Submodules option. Some required sources, including the Dojo Toolkit as well as the GridX widget (which is used by the davinci.gridx Maqetta plug-in) are not included in the Maqetta repository. Instead, it is referenced via a submodule. Checking this option is necessary to pull in the source so that it's available at runtime when using the Eclipse launch scripts.

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.

Window Users: If you are using Git on the command line, be aware that Git on Windows does not properly handle the executable bit on files. For that reason, you will need to go to the directory that contains your local repository and execute the following line:

git config core.filemode false

Bringing in submodule dependencies

As mentioned above, Maqetta has dependencies which are referenced using git submodules. If you did not check the Clone Submodules option when cloning the Maqetta repository and later decide you want to clone the submodule, you can use EGit support for working with submodules or run the following Git command on the command line, within the directory containing your local repository:

git submodule update --init

Set up and launch the Maqetta server

  1. Maqetta requires a directory on the local file system, for its workspace and project files. The launch configurations look for an environment variable called MAQETTA_WORKSPACE. Set this environment variable to point to the directory.

    • Windows: Set in the environment variables section under System Settings.
    • Mac OS X: Follow these instructions
  2. Open the launch configurations by selecting Run->Run Configurations... from the menu bar. The Maqetta launch configs are listed under OSGi Framework in the panel on the left hand side.

    • maqetta multi-user - launches the server with support for multiple users and requires you to log in.
    • maqetta single-user - launches the server with support for only a single user, does not require authentication
  3. Run the launch configuration:

    • After selecting one of the launch configs, click on the Run button.
    • In the Eclipse Console view, you will 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:8081/maqetta.

Optional Setup


If you are going to do JS development in Eclipse, you should install the JSHint Eclipse Plugin. JSHint performs code validation much better than the JS Validator in Eclipse.

Install/usage instructions:

  1. Install the JSHint Eclipse plugin by following the instructions at You'll need to restart Eclipse.
  2. Make sure JS Validator is turned off. Open Preferences, select JavaScript->Validator->Error/Warnings and make sure "Enable JavaScript semantic validation" is unchecked.
  3. Show the Problems view. Click on view menu (downward facing triangle at right) and select Show->Errors/Warnings on Selection. This will make it so the Problems view shows JSHint warnings for the current file.
    • [OPTIONAL] Also in the view menu select Sort By->Location.
  4. Turn on auto-build. From the menu, enable Project->Build Automatically.

Best to code with the Problems view open at the bottom. Double-clicking on an entry in the view takes you to the line in the source.