Skip to content

Allow AEM Authors to use “basic” set of Editable Templates / Core Components to create WET compatible pages/components

License

Notifications You must be signed in to change notification settings

adobe/aemwettemplates

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Adobe AEM - WET Compatible Website Templates and Components

Introduction

This project leverages Adobe AEM Sites and AEM Forms to create a citizen facing web interfaces to provide online services.

The web interface is built using Adobe recommended best practices and leverages Government of Canada approved technology and UX standards.

The web interfaces includes the following:

  • A set of AEM Sites WET compliant page templates and components that are using the latest Adobe Core Components. These WET compliant templates and components are used to build the informational part of the web interface.

  • The templates are based on editable templates

  • A set of AEM Forms WET compliant templates and components. These components are used to create the data capture/wizard interfaces to capture end-user data.

  • A sample bilingual website structure that leverages AEM to maintain dependency between languages.

  • A User service section that provides a list of available forms as well as forms that were submitted or saved as draft

Web Experience Toolkit (WET) includes reusable components for building and maintaining innovative websites that are accessible, usable, and interoperable (more details around WET can be found at https://github.com/wet-boew/wet-boew). Any web sites hosted for Government of Canada must create WET compatible HTML to meet WET accessibility requirements.

Purpose of this project is to allow AEM Authors to use “basic” set of Editable Templates / Core Components to create WET compatible pages.

Sample page created with the package:

GCHome

Sample form created with the package:

AF

Usage

Prerequisites/ Initial Setup

Following is list of dependencies:

  • Application is developed/compiled for AEM 6.5 SP7
  • Corresponding AEM Forms add-on package should be deployed
  • AEM Core Components package is included as part of ui.apps (current version is specified in “main” pom.xml)
  • Required WET CSS/JS files are referenced from www.canada.ca

As part of initial setup, following packages should be deployed to AEM instance:

  • ui.apps
  • ui.content

Modules

The main parts of the application are:

  • core: Java bundle containing all core functionality like OSGi services, Sling rewriter and component-related Java code.
  • ui.apps: contains the /apps parts of the project, ie JS&CSS clientlibs, components, runmode specific configurations
    • AEM Core Components are embedded and deployed as part of ui.apps
    • Required WET CSS/JS files are referenced from www.canada.ca
  • ui.content: contains editable template configuration and sample content using the components from the ui.apps
    • Pages /content/uxp
    • Assets /content/dam/uxp
    • Forms /content/forms/af/uxp
    • Ex. Fragments /content/experience-fragments/uxp
    • Editable templates /conf/uxp

Package download

A zip version of the packages are available to download from https://github.com/adobe/aemwettemplates/releases.

They can be installed using AEM Package Manager. For more information on AEM Package Manager refer to https://experienceleague.adobe.com/docs/experience-manager-65/administering/contentmanagement/package-manager.html?lang=en#contentmanagement.

How to build

Note: Set JAVA_HOME to Java 1.8 To build all the modules run in the project root directory the following command with Maven 3:

mvn clean install

If you have a running AEM instance you can build and package the whole project and deploy into AEM with

mvn clean install -PautoInstallPackage

Or to deploy it to a publish instance, run

mvn clean install -PautoInstallPackagePublish

Or alternatively

mvn clean install -PautoInstallPackage -Daem.port=4503

Or to deploy only the bundle to the author, run

mvn clean install -PautoInstallBundle

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

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.