Welcome to CQBlueprints - A resource for your Adobe CQ 5.4, 5.5, 5.6 and AEM6 projects. Get your CQ project on the right track.

About this Guide

The inststructions in this document are tailored to projects that have been setup with the maven archetype provided in the setup section of this guide. The guide shows how to set up your development environment based on the proposed maven structure and the development server outlined.

You Will Need


Setting Up (Windows)

Java JDK6:
1. Run the Java 6 JDK installer. The default options should be fine.
1. Unzip the Eclipse archive somewhere on your computer, e.g. C:\Eclipse. It is not recommended to install Eclipse into C:\Program Files.
2. Open the eclipse folder, right-click on eclipse.exe, and choose "Pin to Start Menu."
1. Run the Tortoise install executable. Again, default options should work just fine.
1. Create a folder for your CQ instance to live in, e.g. C:\Users\yourname\cq5\, and copy the quickstart jar and license.properties file there.
2. Rename the CQ jar to cq5-author-4502.jar. This tells CQ that it is running as an author instance on port 4502.
Apache Maven
1. Unzip the Maven archive file somewhere on your computer, e.g. C:\maven.
Environment Variable Setup
1. Press start, type "environment variables" into the search box, and choose "Edit the system environment variables." When the System Properties window pops up, click the "Environment Variables..." button at the bottom.

2. Press the "New..." button under System Variables and enter "JAVA_HOME" as the variable name. Enter the path to your JDK's intalled location (Typically C:\Program Files\Java\jdk1.6.something) in the variable value field and press OK.


3. Select the "Path" variable in the System Variables section and press "Edit..." Type a semicolon at the end of the variable value string and enter the path to your maven installation's bin folder (e.g. C:\maven\bin). Press OK on the edit dialog, then press OK for the Environment Variables window and exit the System Properties.


Obtaining and setting up the source code

1. Create a folder somewhere on your file system to put the source code. Right click and choose "SVN Checkout..." from the context menu. For the URL of Repository field, paste in the path to your project's SVN trunk. Ensure that the Checkout Depth is set to "Fully recursive" and the Revision is set to the HEAD revision. Select OK to check out the source files.

2. Shift+Right-Click on the folder containing the source code and select "Open command window here" to get a command prompt.

3. Enter the command "mvn clean install eclipse:eclipse". This tells maven to download all the required dependencies and build the project files. It also will generate the files required for using Eclipse with the project. This will take a little while to run the first time you build the project. Leave this command window open, as we will use it later. If your system can't find the "mvn" program, make sure you correctly added maven's \bin folder to the path (not the main folder).

4. Start up Eclipse. The default location for the workspace is fine. From the File menu, choose "Import...". In the window that appears, expand the "General" category and choose "Existing Projects into Workspace." Hit next and then hit the "Browse..." button next to the "Select root directory" field. Navigate to and select the folder where the source code is stored. A list of the different sub projects should pop up, make sure they are all selected and then choose Finish.

Setting up CQ

1. Navigate to the folder where your CQ jar and license.properties file are located. Double click on the jar file to start the server. It will take a little while to start up the first time, as it has to extract all the required files. When it finishes starting up, your browser should open a window to http://localhost:4502. Login with the credentials "admin", password "admin".

2. Go back to the command prompt (or open a new one in the folder where the source code is). Type in the command "mvn -Pauto-deploy clean install". This will rebuild the project files and deploy them to your CQ server. You will want to run this command whenever you make changes in Eclipse to deploy those changes onto the server.

Congratulations, you should now have a fully working CQ development environment!

Do you find the information on this site useful? Do you think we should add an article on a specific subject? We'd like to hear from you. Please drop us an email @ info@headwire.com

Search CQ Related Information