https://github.com/kevinroberts/wknd-international

Adobe WKND Tutorials + Kevin addons
https://github.com/kevinroberts/wknd-international

Last synced: 5 days ago
JSON representation

Adobe WKND Tutorials + Kevin addons

• Host: GitHub
• URL: https://github.com/kevinroberts/wknd-international
• Owner: kevinroberts
• Created: 2020-04-23T00:48:28.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-08-11T15:57:49.000Z (over 2 years ago)
• Last Synced: 2024-04-09T15:28:25.732Z (7 months ago)
• Language: JavaScript
• Size: 95 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Sample AEM project template

This is a project template for AEM-based applications. It is intended as a best-practice set of examples as well as a potential starting point to develop your own functionality.

## Modules

The main parts of the template 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

* ui.frontend: an optional dedicated front-end build mechanism based on Webpack

## 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

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:

    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