/aem-teams

Teams Collaboration in AEM with Component Audit Logs

Primary LanguageJavaMIT LicenseMIT

AEM Teams and Component Audit Logs

This project is an open source solution for integrating AEM Teams for AEM. It also provides an underlying component audit log for more granular information.

Modules

The main parts of the solution are:

  • core: Java bundle containing all core functionality like OSGi services, listeners or schedulers, as well as component-related Java code such as servlets or request filters.
  • ui.apps: contains the /apps (and /etc) parts of the project, ie JS&CSS clientlibs, components, and templates
  • ui.config: contains runmode specific OSGi configs for the project
  • all: a single content package that embeds all of the compiled modules (bundles and content packages) including any vendor dependencies

How to build

To build all the modules run in the project root directory the following command with Maven 3:

mvn clean install

To build all the modules and deploy the all package to a local instance of AEM, run in the project root directory the following command (this code is an author only solution and shoud not be deployed to a publish instance):

mvn clean install -PautoInstallSinglePackage

Or alternatively

mvn clean install -PautoInstallSinglePackage -Daem.port=4503

Or to deploy only the bundle to the author, run

mvn clean install -PautoInstallBundle

Or to deploy only a single content package, run in the sub-module directory (i.e ui.apps)

mvn clean install -PautoInstallPackage

The configuration provides sensible defaults for a typical local installation of AEM. If you want to point the integration tests to different AEM author and publish instances, you can use the following system properties via Maven's -D flag.

Property Description Default value
aem.host host of the author instance localhost
aem.port Admin user for the author instance 4502
vault.user user of the admin user for the author instance admin
vault.password password of the admin user for the author instance admin

ClientLibs

The frontend module is made available using an AEM ClientLib. .

A ClientLib will consist of the following files and directories:

  • css/: CSS files which can be requested in the HTML
  • css.txt (tells AEM the order and names of files in css/ so they can be merged)
  • js/: JavaScript files which can be requested in the HTML
  • js.txt (tells AEM the order and names of files in js/ so they can be merged
  • resources/: Source maps, non-entrypoint code chunks (resulting from code splitting), static assets (e.g. icons), etc.

Maven settings

The project comes with the auto-public repository configured. To setup the repository in your Maven settings, refer to:

http://helpx.adobe.com/experience-manager/kb/SetUpTheAdobeMavenRepository.html