Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aem-vite/aem-vite

Bring your next AEM project into the modern era with the power of Vite.
https://github.com/aem-vite/aem-vite

aem aem-tools build-tool clientlibs front-end vite

Last synced: about 2 months ago
JSON representation

Bring your next AEM project into the modern era with the power of Vite.

Host: GitHub
URL: https://github.com/aem-vite/aem-vite
Owner: aem-vite
License: apache-2.0
Created: 2021-04-08T14:33:38.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-04-10T21:21:29.000Z (5 months ago)
Last Synced: 2024-05-01T17:02:08.083Z (5 months ago)
Topics: aem, aem-tools, build-tool, clientlibs, front-end, vite
Language: Java
Homepage: https://aemvite.dev
Size: 787 KB
Stars: 26
Watchers: 3
Forks: 3
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        


  

    

  








  

  

  

  

  

  

  

  

  






# AEM Vite

AEM Vite is a transparent handler for the next generation front end tool, [Vite](https://vitejs.dev/). 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](https://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](./.github/commit-convention.md)