Skip to content
Tutorial Code companion for Getting Started Developing with AEM Sites WKND Tutorial
JavaScript CSS Java HTML
Branch: master
Clone or download
Latest commit f56cdd7 Jan 15, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
all Update ui.content filters to avoid overwriting content Jan 9, 2020
core [maven-release-plugin] prepare for next development iteration Dec 21, 2019
dispatcher [maven-release-plugin] prepare for next development iteration Dec 21, 2019
it.launcher
it.tests [maven-release-plugin] prepare for next development iteration Dec 21, 2019
repository-structure [maven-release-plugin] prepare for next development iteration Dec 21, 2019
ui.apps Issue 75 updated content (#76) Jan 7, 2020
ui.content updates to filters (#82) Jan 10, 2020
ui.frontend added lazy load icon (#78) Jan 7, 2020
.gitignore Solution/chapter 8 (#2) May 6, 2019
CODE_OF_CONDUCT.md code of conduct and license info May 3, 2019
CONTRIBUTING.md code of conduct and license info May 3, 2019
LICENSE code of conduct and license info May 3, 2019
README.md Updated reference site Dec 20, 2019
pom.xml Issue 53/favicon (#73) Jan 4, 2020

README.md

WKND Sites Project

This is the code for the WKND Reference site: https://www.wknd.site/

There is also a corresponding tutorial where you can learn how to implement a website using the latest standards and technologies in Adobe Experience Manager (AEM):

  1. WKND Tutorial Overview
  2. Project Setup
  3. Component Basics
  4. Pages and Templates
  5. Client-Side Libraries
  6. Style a Component
  7. Custom Component
  8. Unit Testing

Modules

The main parts of the project are:

  • core: Java bundle containing all core functionality like OSGi services, listeners or schedulers, as well as component-related Java code such as servlets or request filters.
  • ui.apps: contains the /apps (and /etc) parts of the project, ie JS&CSS clientlibs, components, templates, runmode specific configs as well as Hobbes-tests
  • ui.content: contains sample content using the components from the ui.apps
  • ui.tests: Java bundle containing JUnit tests that are executed server-side. This bundle is not to be deployed onto production.
  • ui.launcher: contains glue code that deploys the ui.tests bundle (and dependent bundles) to the server and triggers the remote JUnit execution

How to build

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

Depending on your maven configuration, you may find it helpful to force the resolution of the Adobe public repo with

mvn clean install -PautoInstallPackage -Padobe-public

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

Testing

There are three levels of testing contained in the project:

  • unit test in core: this show-cases classic unit testing of the code contained in the bundle. To test, execute:

    mvn clean test
    
  • server-side integration tests: this allows to run unit-like tests in the AEM-environment, ie on the AEM server. To test, execute:

    mvn clean verify -PintegrationTests
    
  • client-side Hobbes.js tests: JavaScript-based browser-side tests that verify browser-side behavior. To test, go in the browser, open the page in 'Developer mode', open the left panel and switch to the 'Tests' tab and find the generated 'MyName Tests' and run them.

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
You can’t perform that action at this time.