shashi0256 / neba-sample-project

A demo application for NEBA (http://neba.io) for Apache Sling

NEBA Directive: a sample application for the NEBA framework for Apache Sling

This project demonstrates core concepts and features of the NEBA framework for Sling. It provides a demonstrative mini WEB application for the beautiful responsive directive template set by http://html5up.net. The application was created as part of a presentation of the 2015 .adaptTo conference in Berlin, Germany and is continuously updated to serve as a sample project for NEBA.

What this sample application is

This application demonstrates how NEBA can be used to model resources in Sling and use Spring's MVC features for Apache Sling.

What this sample application is not

A ready-to-use web application. It has purely been designed to demonstrate NEBA features.

How to run this application

1. Build the Neba Sample bundle in the root directory with mvn install
2. Build the Neba Sample Launchpad in the launchpad directory with mvn install
3. Start your Neba Sample Launchpad in the launchpad directory with mvn slingstart:start (Can be stopped again by pressing any key)
4. Open http://localhost:8080/content/neba-sample.html.
5. You may login with any sling user, e.g. using admin/admin for the default administrative account.
6. To configure the SMTP settings for the contact form, see /system/console/configMgr, "io.neba.sample.mail" and "NEBA sample project contact email sender".

The anatomy of this app

The NEBA sample app is an OSGi bundle. It contains application code (Java POJOs, Services annotated with SCR metadata, NEBA models) in the "to.adapt.neba" package.

The bundle is blueprint-enabled as it provides a blueprint context xml file in OSGI-INF/blueprint.

In addition, the bundle provides JCR content, views, images and configurations via Sling content loading. The respective content is contained in the SLING-INF/content folder and is loaded into the repository as specified by the Sling-Initial-Content header values defined in the pom.xml.

Furthermore, the bundle directly provides static resources via the Sling-Bundle-Resources header value defined in the pom.xml.