archetype-resources.README.md Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of io.wcm.maven.archetypes.aem
Maven Archetype for creating new AEM projects.
The newest version!
#set( $symbol_pound = '#' )
#set( $symbol_dollar = '$' )
#set( $symbol_escape = '\' )
#set($aemProductName = "#if($optionAemVersion=='cloud')AEMaaCS SDK#{else}AEM ${optionAemVersion}#end")
${projectName}
${projectName.replaceAll('.','=')}

This is an AEM project set up with the [wcm.io Maven Archetype for AEM][wcmio-maven-archetype-aem].


$symbol_pound$symbol_pound$symbol_pound Build and deploy

To build the application run

```
mvn clean install
```

To build and deploy the application to your local AEM instance use these scripts:

* `build-deploy.sh` - Build and deploy to author instance
* `build-deploy-publish.sh` - Build and deploy to publish instance
* `build-deploy-author-and-publish.sh` - Build, and then deploy to author and publish instance (in parallel)

The first deployment may take a while until all updated OSGi bundles are installed.

After deployment you can open the sample content page in your browser:

* Author: http://localhost:${aemAuthorPort}/editor.html/content/${projectName}/en.html
* Publish: http://localhost:${aemPublishPort}/content/${projectName}/en.html

You can deploy individual bundles or content packages to the local AEM instances by using:

* `mvn -Pfast cq:install` - Install and deploy bundle or content package to author instance
* `mvn -Pfast,publish cq:install` - Install and deploy bundle or content package to publish instance

$symbol_pound$symbol_pound$symbol_pound System requirements

* Java ${optionJavaVersion}
* Apache Maven 3.6.0 or higher
* $aemProductName author instance running on port ${aemAuthorPort}
* Optional: $aemProductName publish instance running on port ${aemPublishPort}
#if ( $optionAemVersion != "cloud" )
* To obtain the latest service packs via Maven you have to upload them manually to your Maven Artifact Manager following [these conventions][aem-binaries-conventions] for naming them.

It is recommended to set up the local AEM instances with `nosamplecontent` run mode.
#end


$symbol_pound$symbol_pound$symbol_pound Project overview

Modules of this project:

* [parent](parent/): Parent POM with dependency management for the whole project. All 3rdparty artifact versions used in the project are defined here.
#if ( $optionFrontend == "y" )
* [frontend](frontend/): Frontend build project with webpack
#end
#if ( $optionSlingInitialContentBundle == "y" )
* [bundles/core](bundles/core/): OSGi bundle containing:
  * Java classes (e.g. Sling Models, Servlets, business logic) with unit tests
#if ( $optionEditableTemplates == "y" )
  * AEM components with their scripts and dialog definitions (included as `Sling-Initial-Content`)
#else
  * AEM templates and components with their scripts and dialog definitions (included as `Sling-Initial-Content`)
#end
  * i18n
#if ( $optionMultiBundleLayout == "n" )
  * HTML client libraries with JavaScript and CSS
#else
* [bundles/clientlibs](bundles/clientlibs/): OSGi bundle containing the HTML client libraries with JavaScript and CSS
#end
#else
* [bundles/core](bundles/core/): OSGi bundle with Java classes (e.g. Sling Models, Servlets, business logic).
* [content-packages/ui.apps](content-packages/ui.apps/): AEM content package containing:
#if ( $optionEditableTemplates == "y" )
  * AEM components with their scripts and dialog definitions
#else
  * AEM templates and components with their scripts and dialog definitions
#end
  * HTML client libraries with JavaScript and CSS
  * i18n
#end
#if ( $optionAemVersion != "cloud" )
* [content-packages/complete](content-packages/complete/): AEM content package containing all OSGi bundles of the application and their dependencies
#end
#if ( $optionWcmioConga != "y" )
* [content-packages/osgi-config](content-packages/osgi-config/): AEM content package with OSGi configuration
#if ( $optionWcmioHandler == "y" )
* [content-packages/rewriter-config](content-packages/osgi-config/): AEM content package with rewriter configuration
#end
#end
#if ( $optionEditableTemplates == "y" )
* [content-packages/conf-content](content-packages/conf-content/): AEM content package with editable templates stored at `/conf`
#end
* [content-packages/sample-content](content-packages/sample-content/): AEM content package containing sample content (for development and test purposes)
#if ( $optionWcmioConga == "y" )
* [config-definition](config-definition/): Defines the CONGA roles and templates for this application. Also contains a `development` CONGA environment for deploying to local development instances.
#else
* [all](all/): AEM content package containing all files for cloud deployment
* [dispatcher](dispatcher/): HTTP & Dispatcher configuration files
#end
#if ( $optionIntegrationTests == "y" )
* [tests/integration](tests/integration/): Integration tests running against the HTTP interface of AEM
#end


[wcmio-maven-archetype-aem]: https://wcm.io/tooling/maven/archetypes/aem/
[wcmio-maven]: https://wcm.io/maven.html
#if ( $optionAemVersion != "cloud" )
[aem-binaries-conventions]: https://wcm-io.atlassian.net/wiki/x/AYC9Aw
#end