golinski / themeclean-flex Goto Github PK

This project was created by the Sling Project Maven Archetype which created two modules:

1. core: OSGi Bundle deployed to Sling which includes your Servlets, Filters, Sling Models and much more. This module is not intended to contain Sling Content.
2. ui.apps: JCR Content Module which is used to install a JCR Package into Sling by using Composum. For that it must be installed and the Composum Package Manager must be whitelisted.

There are also two modules which provide some examples; these have the same name as above but with an extension .example. These modules should not be deployed, they are examples for you to use in creating your own core or ui.apps modules.

The structure of both modules are the same and so copying them over just be quite simple.

Due to the way Apache Maven Archetypes work both example modules are added to the parent POM's module list. Please remove them after you created your own to avoid the installation of these modules into Sling. At the end of the parent POM you will find the lines below. Remove the lines with core.example and ui.apps.example.

<modules>
    <module>core</module>
    <module>core.example</module>
    <module>ui.apps</module>
    <module>ui.apps.example</module>
</modules>

There are several reasons to use a JCR Package instead of a Content Bundle but the most important reason is that a JCR Package allows the Sling Tooling to update a single file rather than an entire Bundle and also to import a Node from Sling into the project.

The project is built quite simple:

mvn clean install

To install the OSGi bundle use the project autoInstallBundle:

mvn clean install -P autoInstallBundle

To install the Content together with the core bundle use the project autoInstallPackage:

mvn clean install -P autoInstallPackage

It is probably best to not deploy the OSGi Bundle alone as this may lead to conflicts with the package deployment.

In case of a mishap the package and bundles need to deinstalled manually:

1. Remove /apps/${appsFolderName}/install folder
2. Uninstall the package using the package manager
3. Remove the package from /etc/packages including the snapshots if they are still there
4. Remove the Bundle using the OSGi Console (/system/console/bundles)

Apache-2.0