Maqetta with Orion Developer Setup

Developer setup for a combined Maqetta and Orion workspace

Maqetta and Orion are Web based development platforms. Maqetta is a WYSIWYG HTML5 editor for web designers and Orion is a source editor and tooling framework for developers.

More about Orion: http://www.eclipse.org/orion/

More about Maqetta: http://www.maqetta.org

Both Orion and Maqetta run on an OSGi framework within an embedded Jetty server. With the maqetta.orion.server and maqetta.orion.client (located in the maqetta github repo), you can run both applications on the same OSGi instance and share the same backing file system and user authentication mechanism.

Basic Setup

1. Exit all Eclipse instances
2. Download the latest maqetta/orion build (http://maqetta.org/builds/). You dont need the 'hosted' version, but be sure to get the appropriate one for your platform.
3. Unzip the download, and keep it somewhere on your disk for later. we're going to use this as the "target environment" to run against. ((i unziped mine to /Users/childsb/dev/target-environments/maqetta-orion/))
4. Launch eclipse, and select a workspace directory ((/Users/childsb/dev/workspaces/maqetta-orion for me)).
5. In eclipse, go to preferences --->plug-in development --->target platform
   • click Add under "Target Platform"
   • select nothing (default) click next
   • click add, select directory click next
   • browse to the unziped maqetta build from step 4
   • name the new target platform something meaningful (i chose maqetta orion built target)
6. Change the target platform to the newly created one by checking its box then clicking apply.

Getting the Maqetta Source

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 http://download.eclipse.org/releases/XXXX). * 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 [email protected]:maqetta/maqetta.git 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 the following projects:

• davinci.dojo_1_8
• davinci.gridx
• davinci.html
• davinci.product (optional)
• davinci.releng (optional)
• davinci.war (optional)
• maqetta.client.orion
• maqetta.clipart
• maqetta.core.client
• maqetta.core.server
• maqetta.server.orion
• maqetta.server.orion.standard
• maqetta.shapes

Many of the other plugins are dependancies and do not need to be explicitly imported and will be loaded from the target environment. DO NOT IMPORT the org.apache.* plugins.

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-orion multi user - launches the server with support for multiple users and requires you to log in.

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.

Notes

• Orion configuration (Standalone) guide - to get the Orion Source: Orion Setup Guide

• All Maqetta projects are cross server compatible. However the backing file system and user store is not. If you start out running the Orion server you'll not be able to switch to standalone server without re-creating users and manually downloading projects and uploading them to the new server.

• Maqetta workbench preferences are not stored in the file system. Instead they are stored via an Eclipse Preferences node.