https://github.com/adobe-consulting-services/acs-aem-commons
https://github.com/adobe-consulting-services/acs-aem-commons
adobe-experience-manager aem aem-as-a-service aem64 aem65 cq cq5 crx jcr oak sling sling-models
Last synced: 23 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/adobe-consulting-services/acs-aem-commons
- Owner: Adobe-Consulting-Services
- License: apache-2.0
- Created: 2013-10-04T13:50:05.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2025-03-31T18:15:24.000Z (2 months ago)
- Last Synced: 2025-04-03T01:59:39.609Z (2 months ago)
- Topics: adobe-experience-manager, aem, aem-as-a-service, aem64, aem65, cq, cq5, crx, jcr, oak, sling, sling-models
- Language: Java
- Homepage: http://adobe-consulting-services.github.io/acs-aem-commons/
- Size: 27.1 MB
- Stars: 463
- Watchers: 100
- Forks: 608
- Open Issues: 337
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# ACS AEM Commons
[](https://central.sonatype.com/artifact/com.adobe.acs/acs-aem-commons-all)
[](https://gitter.im/Adobe-Consulting-Services/acs-aem-commons?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://github.com/Adobe-Consulting-Services/acs-aem-commons/actions)
[](https://codeclimate.com/github/Adobe-Consulting-Services/acs-aem-commons)
[](https://codecov.io/gh/Adobe-Consulting-Services/acs-aem-commons)
[](https://codeclimate.com/github/Adobe-Consulting-Services/acs-aem-commons/maintainability)
This project is a unified collection of AEM/CQ code generated by the AEM consulting practice.
## Using
Please refer to [Add ACS AEM Commons to your AEM Maven project](https://adobe-consulting-services.github.io/acs-aem-commons/pages/maven.html) for how to install its package and use its API.
### Prerequisites
The prerequisites are listed in [Compatibility](https://adobe-consulting-services.github.io/acs-aem-commons/pages/compatibility.html).
### Distribution
+ Maven artifact available from Maven central: [https://central.sonatype.com/artifact/com.adobe.acs/acs-aem-commons-all](https://central.sonatype.com/artifact/com.adobe.acs/acs-aem-commons-all)
+ Github releases: [https://github.com/Adobe-Consulting-Services/acs-aem-commons/releases](https://github.com/Adobe-Consulting-Services/acs-aem-commons/releases)
## Building
This project uses Maven for building. Common commands:
From the root directory, run `mvn -PautoInstallPackage clean install` (for AEM 6.5) or `mvn -PautoInstallPackage,cloud clean install` (for AEMaaCS) to build the bundles and content packages and install the container package to an AEM instance.
From the bundle directory, run `mvn -PautoInstallBundle clean install` to build *just* the bundle and install to an AEM instance. In addition there is the profile `autoInstallUiAppsPackage` to just install the `ui.apps` package to AEM.
The Maven profile `cloud` is used to both build both the AEMaaCS and the AEM 6.5 packages/bundles as well as to optionally install the version targeted for AEMaaCS (with the additional profile `autoInstallPackage` or `autoInstallUiPackage`). It is automatically active when no other profile is activated via command line or `settings,.xml`.
To build only the version for AEM 6.5 (without using any other profiles) use the command line option `-P \!cloud` [to deactivate the default profile `cloud`](https://maven.apache.org/guides/introduction/introduction-to-profiles.html#deactivating-a-profile).
### Deploying with VLT
To use vlt with this project, first build and install the package to your local AEM instance as described above. Then cd to `content/src/main/content/jcr_root` and run
vlt --credentials admin:admin checkout -f ../META-INF/vault/filter.xml --force http://localhost:4502/crx
Once the working copy is created, you can use the normal ``vlt up`` and ``vlt ci`` commands.
### Specifying AEM Host/Port
The AEM host and port can be specified on the command line with:
mvn -Dcrx.host=otherhost -Dcrx.port=5502
### Rules
* Spaces, not tabs.
* Provide documentation in the parent org GH project: https://github.com/Adobe-Consulting-Services/adobe-consulting-services.github.io
* Target AEM as a Cloud Service. AEM 6.5.x only features can still be contributed, but please create a Feature Review Github Issue before working on them to ensure they will accepted. Check the [compatibility table](http://adobe-consulting-services.github.io/acs-aem-commons/pages/compatibility.html) for compatibility of older versions.
* API classes and interfaces must have JavaDocs. Not necessary for implementation classes.
* Don't use author tags. This is a community project.
## Want commit rights?
* Create an issue.