Creating an AEM Application using Adobe's archetype version 23

In this tutorial, I will show how to use Adobe's archetype to create an AEM application using version 23rd and up, above is the vid and below you will find some useful notes.

1. 1.

   Pre-reqs

   • Have access to an Adobe Experience Manager instance. You will need aem 6.3 Service Pack 3, AEM 6.4 or AEM 6.5
2. 2.

   Creating an AEM application using archetype version 23

   • Look for the .m2 folder inside your user for your particular Operating System (C:\Users\YOUR-USERNAME\.m2\settings.xml for Windows or ~/.m2/settings.xml for Linux or Mac) and create or edit the settings.xml file inside that folder.

     <settings xmlns="https://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="https://maven.apache.org/SETTINGS/1.0.0
                           https://maven.apache.org/xsd/settings-1.0.0.xsd">
         <profiles>
             <!-- ====================================================== -->
             <!-- A D O B E   P U B L I C   P R O F I L E                -->
             <!-- ====================================================== -->
             <profile>
                 <id>adobe-public</id>
                 <activation>
                     <activeByDefault>true</activeByDefault>
                 </activation>
                 <properties>
                     <releaseRepository-Id>adobe-public-releases</releaseRepository-Id>
                     <releaseRepository-Name>Adobe Public Releases</releaseRepository-Name>
                     <releaseRepository-URL>https://repo.adobe.com/nexus/content/groups/public</releaseRepository-URL>
                 </properties>
                 <repositories>
                     <repository>
                         <id>adobe-public-releases</id>
                         <name>Adobe Public Repository</name>
                         <url>https://repo.adobe.com/nexus/content/groups/public</url>
                         <releases>
                             <enabled>true</enabled>
                             <updatePolicy>never</updatePolicy>
                         </releases>
                         <snapshots>
                             <enabled>false</enabled>
                         </snapshots>
                     </repository>
                 </repositories>
                 <pluginRepositories>
                     <pluginRepository>
                         <id>adobe-public-releases</id>
                         <name>Adobe Public Repository</name>
                         <url>https://repo.adobe.com/nexus/content/groups/public</url>
                         <releases>
                             <enabled>true</enabled>
                             <updatePolicy>never</updatePolicy>
                         </releases>
                         <snapshots>
                             <enabled>false</enabled>
                         </snapshots>
                     </pluginRepository>
                 </pluginRepositories>
             </profile>
         </profiles>
         <activeProfiles>
             <activeProfile>adobe-public</activeProfile>
         </activeProfiles>
     </settings>
     

   • With the 23rd version of the archetype's release there have been many changes to the properties that you can use to configure how the new AEM app is going to be generated.
   • So let’s create the app from scratch. I am providing the most important properties in a single line here given that the other properties will be inferred from them.

     mvn -B archetype:generate "-DarchetypeGroupId=com.adobe.granite.archetypes" "-DarchetypeArtifactId=aem-project-archetype" "-DarchetypeVersion=23" "-DaemVersion=6.5.0" "-DappTitle=First App Example" "-DappId=first-app" "-DgroupId=co.dlighthouse.aem.firstapp" "-DfrontendModule=none" "-DincludeExamples=y" "-DincludeDispatcherConfig=n"
     

     PowerShell

     mvn -B archetype:generate `
       -D archetypeGroupId=com.adobe.granite.archetypes `
       -D archetypeArtifactId=aem-project-archetype `
       -D archetypeVersion=23 `
       -D aemVersion=6.5.0 `
       -D appTitle="First App Example" `
       -D appId="first-app" `
       -D groupId="co.dlighthouse.aem.firstapp" `
       -D frontendModule=none `
       -D includeExamples=y `
       -D includeDispatcherConfig=n
     

   • Let’s build and deploy our new app (make sure that you have AEM up and running)

     mvn clean install -PautoInstallPackage -Padobe-public
     

   • If you're using a different port for AEM

     mvn clean install -PautoInstallPackage -Padobe-public "-Daem.port=PORT-NUMBER"
     

3. 3.

   Resources

   Configuring the settings.xml File with Adobe's Eepository

   Adobe's Archetype

   Adobe's Archetype Available Properties

   AEM Supported Versions

   Adobe's Archetype Releases