Set up local AEM SDK

 Adobe Experience Manager (AEM) can be run locally using the AEM as a Cloud Service SDK’s Quickstart Jar. This allows developers to deploy to, and test custom code, configuration, and content before committing it to source control, and deploying it to a AEM as a Cloud Service environment.

Follow  aem local setup, all steps remain same except AEM SDK jar file.

Download the AEM as a Cloud Service SDK

1. Open Software Distribution portal.  Log in to https://experience.adobe.com/#/downloads with your Adobe ID
2. Note that your Adobe Organization must be provisioned for AEM as a Cloud Service to download the AEM as a Cloud Service SDK.
3. Navigate to the AEM as a Cloud Service tab
4. Sort by Published Date in Descending order or search aem sdk in filters.

   

   Adobe Software Distribution Portal

   
   
5. Click on the latest AEM SDK result row.
6. Review and accept the EULA, and tap the Download button.

Extract the Quickstart Jar 

Unzip the downloaded aem-sdk-XXX.zip file

aem sdk- verion extract

You can see it has dispatcher in the same zip file.Ignore for now

Use cq-author jar for author setup. You can rename this jar to "aem-author-p4502.jar"

• 
  

• Create the folder ~/aem-sdk/author

• Copy aem-author-p-4502.jar to author folder.
• Extract jar by
• java -jar aem-author-p-4502.jar
• Provide admin password as "admin".

• Access the local AEM Author Service at http://localhost:4502 in a Web browser

Setup Publish Instance

Follow same steps for publish instance. Jar name would be "aem-publish-p4503.jar" and extract jar by:

java -jar aem-publish-p4503.jar.

Access the local AEM Publish Service at http://localhost:4503 in a Web browser.

Note:You cannot start the AEM as Cloud Service Quickstart Jar by double-clicking.

Happy Learning!

AEM local Set up

 

Setting up a local development environment is the very first step when establishing an Adobe Experience Manager or AEM. Below is the prerequisite list to setup AEM on local.

Prerequisites:

Following softwares are required for installation on one’s local environment:

AEM jar file- connect with Adobe to get jar file and license properties. You can get temporary license. If you working in an organization then you can coordinate with organization teams to get jar files.

Java( 8+) for AEM-6.5

java-11 for AEM sdk

Maven- 3.5+

 Java Setup

Ø      Download jdk-11 from official site. You can set up via zip extraction or directly with exe file.

For Java JDK 11- Path variables that need to be set:

• Create the system or user variables for the following:
• Open Advance system settings
• Click Environment Variables
• 
  
  

 

Click New in System Variable and add JAVA_HOME to set jdk. Click Ok.

 

Ø      Maven setup

o   Download maven from official site.

o   Extract and set up on your machine. Please follow link to set up on windows:

o   Setting up maven in system variable. Refer above’s screenshot.

Same environment steps for maven.

 Now click path in system variables.

Add below entries for java and maven:

Click New and add below bin path for “Java”

 %JAVA_HOME%\bin

 Click New and add below bin path for “Maven”

 %MAVEN_HOME%\bin

 Click ok and close environment variables.

Ø         AEM Setup

 

o   Copy aem jar file in any folder.

o   Extract the file in a folder.

o   Rename the aem-sdk jar file inside to cq-author-p-4502

    Paste license.properties files in his folder for aem 6.5 or below versions.

o   There is one more dispatcher zip if you are installing aem-sdk. Please ignore at this moment. It would be used for dispatcher setup.

o   Open command prompt here

o   Run below command to create author instance on local machine:

 

 java -jar cq-author-p4502.jar in command prompt.

 

when prompted to enter a password use “admin” as password.

o   Server will be up in 4-5 minutes and the AEM console will open on port 4502.

o   It means author instance is running on 4502 port.

o   Following screen comes up when the server is up:

o   You need to login with the userId/password as admin/admin

and following screen opens and you are good to go! 😊

 

Similarly, setup publish environment by renaming jar file to “cq-publish-p-4503”. It means your publish instance will run on 4503 port.

To start server manually- use below command:

Go to crx-quickstart /bin folder

double click start.bat file for windows

or

run ./start in terminal for mac/linux

AEM Project Setup

This tutorial covers the creation of a Maven Multi Module Project to manage the code and configurations for an Adobe Experience Manager Site.

Prerequisites

• Instance of Adobe Experience Manager available locally.
• java 7+
• maven

We will generate a new Adobe Experience Manager project using the AEM Project Archetype . Your AEM project contains all of the code, content, and configurations used for a Sites implementation.

What is a Maven project? - Apache Maven is a software management tool to build projects. All Adobe Experience Manager implementations use Maven projects to build, manage and deploy custom code on top of AEM.

What is a Maven archetype? - A Maven archetype is a template or pattern for generating new projects. The AEM Project archetype allows us to generate a new project with a custom namespace and include a project structure that follows best practices, greatly accelerating our project.

Create the project

We use version 22 of the archetype. However, it is always a best practice to use the latest version of the archetype to generate a new project.

The next series of steps are:

Step 1: Open command prompt and check maven is installed correctly.

Step 2: Verify that the adobe-public profile is active by running the following command:

Success if adobe-public is active.

If you do not see the adobe-public it is an indication that the Adobe repo is not properly referenced in your ~/.m2/settings.xml file. Please revisit the steps to install and configure Apache Maven in a local development environment .

Step 3: Navigate to a directory in which you want to generate the AEM project.  and run below maven command.

mvn archetype:generate -B \

  -DarchetypeGroupId=com.adobe.granite.archetypes \

  -DarchetypeArtifactId=aem-project-archetype \

  -DarchetypeVersion=22 \

  -DgroupId=com.adobe.aem.guides \

  -Dversion=0.0.1-SNAPSHOT \

  -DappsFolderName=asc \

  -DartifactId=aem-guides-asc \

  -Dpackage=com.adobe.aem.guides.asc \

  -DartifactName="ASC Sites Project" \

  -DcomponentGroupName=ASC \

  -DconfFolderName=asc \

  -DcontentFolderName=asc \

  -DcssId=asc \

  -DisSingleCountryWebsite=n \

  -Dlanguage_country=en_us \

  -DoptionAemVersion=6.5.0 \

  -DoptionDispatcherConfig=none \

  -DoptionIncludeErrorHandler=n \

  -DoptionIncludeExamples=y \

  -DoptionIncludeFrontendModule=y \

  -DpackageGroup=asc \

  -DsiteName="ASC Site"

It will scan and create project in specified directory.

Step 4: You can go the directory and can look below project structure.

For above used properties refer detail here  https://experienceleague.adobe.com/docs/experience-manager-core-components/using/developing/archetype/overview.html?lang=en

Build the project:

Step 1: Go to project: cd aem-guides-asc

Step 2: Run the following command to build and deploy the entire project to AEM:

   mvn clean install -PautoInstallPackage

Note: Please start AEM instance first before running AEM deploy command.

You can run below command to deploy code on AEM publish instance. You can refer parent pom.xml for the same and also README.md file which has all instructions to deploy code.

Step 3: Navigate to the Sites console: http://<host>:<port>/sites.html/content for e.g. if your instance is running on 4502 then open below url in browser and login with username/password. Default credentials would be admin/admin.

http://localhost:4502/sites.html/content .

Open any page from project and if it working fine then we are done!

Congratulations! Your project is set up now.