[go: up one dir, main page]

Skip to content

aem-vite/aem-vite

Repository files navigation

AEM Vite logo


Maven Central Build and Test Sonarcloud Sonar Quality Gate Sonar Coverage Sonar Security Rating GitHub issues GitHub pull requests License


AEM Vite

AEM Vite is a transparent handler for the next generation front end tool, Vite. Tooling can be the most complex piece of a project to complete, Vite for AEM aims to bring speed and simplicity without needing to invest hours of your time upfront.

Getting Started

Visit aemvite.dev for install instructions.

Modules

The main parts are:

  • core: Java bundle containing all core functionality
  • ui.apps: contains the /apps parts of the project
  • ui.config: contains runmode specific OSGi configs for the project
  • all: a single content package that embeds all the compiled modules (bundles and content packages) including any vendor dependencies

How to build

To build all the modules run in the project root directory the following command with Maven 3:

mvn clean install

To build all the modules and deploy the all package to a local instance of AEM, run in the project root directory the following command:

mvn clean install -PautoInstallSinglePackage

Or to deploy it to a publish instance, run

mvn clean install -PautoInstallSinglePackagePublish

Or alternatively

mvn clean install -PautoInstallSinglePackage -Daem.port=4503

Or to deploy only the bundle to the author, run

mvn clean install -PautoInstallBundle

Or to deploy only a single content package, run in the sub-module directory (i.e ui.apps)

mvn clean install -PautoInstallPackage

Unit tests

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

mvn clean test

Static Analysis

The analyse module performs static analysis on the project for deploying into AEMaaCS. It is automatically run when executing

mvn clean install

from the project root directory. Additional information about this analysis and how to further configure it can be found here https://github.com/adobe/aemanalyser-maven-plugin

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

Contributing

Before committing any changes please ensure you run yarn install and follow the commit convention