generate-typescript-maven-plugin Maven Plugin

aem react library and demo

License

License

MIT
Categories

Categories

Maven Build Tools React User Interface Web Frameworks
GroupId

GroupId

com.sinnerschrader.vw.aem.react
ArtifactId

ArtifactId

generate-typescript-maven-plugin
Last Version

Last Version

0.23.1
Release Date

Release Date

Type

Type

maven-plugin
Description

Description

generate-typescript-maven-plugin Maven Plugin
aem react library and demo

Download generate-typescript-maven-plugin

How to add to project

<plugin>
    <groupId>com.sinnerschrader.vw.aem.react</groupId>
    <artifactId>generate-typescript-maven-plugin</artifactId>
    <version>0.23.1</version>
</plugin>

Dependencies

compile (8)

Group / Artifact Type Version
com.sinnerschrader.vw.aem.react : aem-react-api jar 0.23.1
org.apache.maven : maven-plugin-api jar 3.0
com.google.code.javaparser : javaparser jar 1.0.8
commons-io : commons-io jar 2.4
commons-lang : commons-lang jar 2.1
com.github.jknack : handlebars jar 4.0.6
org.projectlombok : lombok jar 1.16.18
io.github.lukehutch : fast-classpath-scanner jar 2.9.3

provided (1)

Group / Artifact Type Version
org.apache.maven.plugin-tools : maven-plugin-annotations jar 3.4

test (2)

Group / Artifact Type Version
junit : junit jar 4.12
com.fasterxml.jackson.core : jackson-databind jar 2.5.3

Project Modules

There are no modules declared in this project.

Adobe Experience Manager ("AEM") components written in React


This project makes it possible to render Adobe Experience Manager ("AEM") components via React.

STATUS

Build Status Maven Central

  • Version: 0.4
  • API is unstable

Documentation

An comprehensive documentation is being developed.

Deploy / install the demo

You can download the demo content package from here and deploy it to your local AEM instance. View the demo

To install the demo locally:

git clone https://github.com/sinnerschrader/aem-react.git

cd aem-react

mvn clean install -PautoInstallPackage -Dgpg.skip=true

##Trouble shooting

Nashorn engine erro: "No such function renderReactComponent"

Check configuration of ReactScriptEngine in webconsole:

  • go to /system/console/configMgr
  • search for "react" in the browser
  • open the configuration of "ReactJs Script Engine Factory"
  • important: jcr path must be "/etc/designs/react-demo/js/react-demo/server.js/jcr:content"
  • if it is not then update it.

Background

Nowadays every web application contains at least some highly interactive ui components that are implemented via javascript in the client.

React is one of the most popular javascript web frameworks today. React makes client-side web application development as easy as good old server side web development because of its "render everthing" ansatz. The developer doesn't need to think about the minimal set of dom manipulations to get to the next state of the ui but instead defines the new state and the framework handles the dom manipulation.

React can be directly used in conjunction with AEM for client-side tasks. Unfortunately that means that the dom that Reactjs handles will not be rendered on the server and thus will not be available on first page load and requires extra work to be indexable by search engines. This project makes it possible to render AEM components with React on the server.

License

MIT

Contribution

Contributions are welcome!

The repository contains the OSGI bundle in the folder core. In the folder demo is a demo project that can be used as a starting point for your own project.

OSGI core bundle

The maven module in ./core contains the implementation of the AEM component type and the pool of nashorn engines.

Demo content package

The maven module in ./demo defines a demo content package that includes some example components and demo pages.

Javascript library

The javascript library is required and integrated by the build tools in the demo project.

Dependencies

  • = Java 8 (Oracle JDK with nashorn engine)

  • = AEM 6.0

com.sinnerschrader.vw.aem.react

SinnerSchrader

We love people who love building things.

Versions

Version
0.23.1
0.23.0
0.22.0