Adobe Experience Manager (AEM) Sites Core Components - flexible, extensible, and feature-rich components to build sites
Java JavaScript HTML CSS
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

AEM Sites Core Components

Build Status Code Coverage

A set of standardized components for AEM 6.3+ that can be used to speed up development of websites.

Documentation

Development

If you're curious about how the next generation of components looks like, a tech preview is made available in the development branch.

Contributing

Contributions are welcome! Read the Contributing Guide for more information.

Available Components

The components' versioning scheme is documented on the AEM Core WCM Components' versioning policies wiki page.

* The Content Fragment Component is an extension to the Core Components and must be separately downloaded and explicitly enabled.

System Requirements

Core Components Extension AEM Java
1.0.0, 1.0.2 - AEM 6.3 1.7
1.0.4, 1.0.6 - AEM 6.3 1.8
1.1.0 sandbox/preview AEM 6.3 + FP19614 or SP 1 1.8
2.0.0 sandbox/preview AEM 6.3 + SP1 + FP20593 1.8
2.0.4 1.0.0 AEM 6.3 + SP1 + CFP2 + FP20593 + FP20696 1.8
2.0.6, 2.0.8 1.0.2, 1.0.4 AEM 6.3 + SP2 1.8
2.1.0 1.0.6 AEM 6.3.2.2 + FP24268, AEM 6.4.1.0 + FP24267 1.8

Installation

To install everything, except the extensions, the released aggregate package core.wcm.components.all can be installed via the AEM Package Manager.

For more information about the Package Manager please have a look at How to Work With Packages documentation page.

Build

The project has the following minimal requirements:

  • Java SE Development Kit 8 or newer
  • Apache Maven 3.3.1 or newer

For ease of build and installation the following profiles are provided:

  • autoInstallSinglePackage - install everything to an existing AEM author instance, as specified by http://${aem.host}:${aem.port}
  • autoInstallSinglePackagePublish - install everything to an existing AEM publish instance, as specified by http://${aem.publish.host}:${aem.publish.port}
  • autoInstallPackage - installs the package/bundle to an existing AEM author instance, as specified by http://${aem.host}:${aem.port}
  • autoInstallPackagePublish - installs the package/bundle to an existing AEM publish instance, as specified by http://${aem.publish.host}:${aem.publish.port}

UberJar

This project relies on the unobfuscated AEM 6.3 cq-quickstart. This is publicly available on https://repo.adobe.com

For more details about the UberJar please head over to the How to Build AEM Projects using Apache Maven documentation page.

Install everything

You can install everything needed to use the components on your running AEM instance by issuing the following command in the top level folder of the project:

mvn clean install -PautoInstallSinglePackage

Individual packages/bundles

You can install individual packages/bundles by issuing the following command in the top level folder of the project:

mvn clean install -PautoInstallPackage -pl <project_name(s)> -am

Please note that

  • -pl/-projects option specifies the list of projects that you want to install
  • -am/-also-make options specifies that dependencies should also be built

Include core components as subpackage into your own project maven build

The released version of the core components are available on the public maven repository at https://repo.adobe.com. To include the core components package into your own project maven build you can add the dependency

<dependency>
    <groupId>com.adobe.cq</groupId>
    <artifactId>core.wcm.components.all</artifactId>
    <type>zip</type>
    <version>2.1.0</version>
</dependency>

and sub package section

<subPackage>
    <groupId>com.adobe.cq</groupId>
    <artifactId>core.wcm.components.all</artifactId>
    <filter>true</filter>
</subPackage>

to the content-package-maven-plugin.

For more information how to setup the Adobe Maven Repository (repo.adobe.com) for your maven build, please have a look at the related Knowledge Base article