From b847667bfe761888123a65f6b663eff655ee28e0 Mon Sep 17 00:00:00 2001 From: Daniel Gordon Date: Wed, 10 Jun 2020 08:40:23 -0700 Subject: [PATCH] updated README --- README.md | 40 ++++++++++++++++++++++++++++++---------- 1 file changed, 30 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index be10d6ae..b96bbdd8 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,37 @@ This is the code companion for a series of tutorials designed for developers new to the **SPA Editor** feature in Adobe Experience Manager (AEM). There are two parallel versions of the tutorial: -* [Create your first React SPA in AEM](https://docs.adobe.com/content/help/en/experience-manager-learn/tutorials/develop-spa-react/overview.html) * [Create your first Angular SPA in AEM](https://docs-stg.corp.adobe.com/content/help/en/experience-manager-learn/tutorials/develop-spa-angular/overview.html) +* [Create your first React SPA in AEM](https://docs.adobe.com/content/help/en/experience-manager-learn/tutorials/develop-spa-react/overview.html) + +The starter and solution branches in this repository correspond to **Angular** and **React** versions of the tutorial. + +## 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 and runmode specific configs +* **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.frontend**: an optional dedicated front-end build mechanism. Depending on the branch this will be either the **React** or **Angular** source code. + +## 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 -PautoInstallSinglePackage + +Or to deploy it to a publish instance, run + + mvn clean install -PautoInstallSinglePackagePublish -The starter and solution branches in this repository correspond to **React** and **Angular** versions of the tutorial. +### Building for AEM 6.x.x -## React Branches +The project has been designed for **AEM as a Cloud Service**. The project is also backward compatible with AEM **6.4.8** by adding the `classic` profile when executing a build, i.e: -* **Create a Project** - * [Tutorial](https://docs.adobe.com/content/help/en/experience-manager-learn/tutorials/develop-spa-react/create-project.html) - * [Solution](https://github.com/adobe/aem-guides-wknd-spa/tree/React/create-project-solution) -* **Integrate the SPA** - * [Tutorial](https://docs.adobe.com/content/help/en/experience-manager-learn/tutorials/develop-spa-react/integrate-spa.html) - * [Start](https://github.com/adobe/aem-guides-wknd-spa/tree/React/integrate-spa-start) - * [Solution](https://github.com/adobe/aem-guides-wknd-spa/tree/React/integrate-spa-solution) \ No newline at end of file + mvn clean install -PautoInstallSinglePackage -Pclassic \ No newline at end of file