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.

Introduction

If you have a small or large team that's developing for Adobe CQ, you want to bring saome structure into your process. CRXDE|lite is fine to poke around CQ for a bit or debug an issue but if everybody works directly in CRXDE|liite you won't have a nice process on sharing your project with each ohter and to setup a new developer easily and quickly. While CRXDE|lite integrates with Subversion, it does not handle conflicts very well. We suggest you use a version control system (for example SVN), develop build scripts for your CQ project (for example Maven), use a continuous integration server to deploy any chances made in the version control system to a CQ instance (for example Jenkins) and store you build archifacts so they can be accessed by all developers and the QA folks (for example Nexus). And last but not least to develop your code, we suggest you use a modern IDE (for example Eclipse).

This section of CQBlueprints focuses on getting your development environment up and running quickly.

Environments

  • Local Development
  • Development CQ Server (Integration)
  • Test CQ Environment
  • Production CQ Environment

Maven Base Project

In order to build your CQ project it is a good idea to setup automated build scripts for your project. While some may be more familiar with ant as a build tool for java projecrs, maven is the tool of choice for CQ since Adobe makes its resources for the plaform available in a maven repository as well. A basic maven setup for a CQ project can be found at http://dev.day.com/content/docs/en/cq/current/developing/developmenttools/developing-with-maven.html on Adobe's website.

We suggest however to use the maven archetype for Adobe CQ provided by CQBlueprints.

 

Source Control System

Any source control system will do, Adobe is currently using subversion (SVN) for the CQ product, therfore we are suggesting to use SVN for your projects as well. For more information about SVN see the following resources:

  • subversion server
  • subversion clients

Continuous Integration

While all the developers are working in their local environment, you want to at least have some development server that contains all the latest source code from all the developers and allows everybody to quickly test their code with all the dependencies. To do so, a continuous integration server allows you to build and update the development environment every time a developer checks in code. We suggest you use Jenkins as your continuous integration server.

Artifact Repository

Maven and Jenkins can deploy to a common maven repository. This allows multiple developers to work on different parts of your site without every developer building all the subsystems all the time. You can also use the maven repository to store the artifacts of releases to the QA group for the test server. In fact, Adobe is providing all of CQ on such a maven repository for you to build your modules against. Adobe currently uses the industry standard software suite called Nexus to do this. We suggest you use the same.

For more information about the reasoning behind these choices, please read the following article


What type of Setup are we proposing?  

In order to develop larger projects with Adobe CQ, CRXDE|Lite is not enough. You want to be able to work seamlessly with larger teams and deploy to your development, test and production environments without a repeatable process. In order to do so, we are suggesting the following tool chain:

  • SVN Version Control Repository
  • Maven Project Structure
  • Jenkins for automated builds
  • Nexus to store snapshots and releases
  • Eclipse (or other IDE) to Develop

The articles and resources to the left show you how to configure these tools and get up and running quickly for your project.

 

Quickstart

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