A reference implementation for using React with AEM
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
core
it.launcher
it.tests
ui.apps
ui.content
.gitignore
README.md
pom.xml

README.md

Pug Ranch 2018

A reference implementation to highlight ideas and concepts not covered in the base AEM Archetype. This particular release highlights using React with AEM and front-end developer productivity.

Front-End Developer Productivity

  1. Start AEM on localhost:4502
  2. In ui.apps, run npm install.
  3. Run npm run aemsync
  4. Open a new terminal run npm run aemlibs

You can now save files (js, xml, less, css, html) and refresh. No maven needed.

This project also uses eslint + Airbnb Style Guide, so it's highly recommended using an eslint plugin for your IDE otherwise you may get build errors. If you don't need these features, feel free to turn them off.

A demo of the front-end developer lifecycle can be found here: https://www.youtube.com/watch?v=uvett3sZlko

React Integration

This feature uses "React DOM Components" to build data models from HTL-rendered DOM and pass these objects into React. You can find information here: https://auniverseaway.github.io/react-dom-components

The Tab Control component uses a Sling Model (and exporter) to get children of the current page. The button on the component will send an AJAX request to simply reverse the order of the list of pages.

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

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