appNG is an open source, horizontally scalable application platform for developing and operating applications efficiently. It can be used to build an Application Platform as a Service (aPaaS).
Java CSS XSLT Shell HTML FreeMarker
Permalink
Failed to load latest commit information.
appng-api preparing release 1.14.4 Jul 28, 2017
appng-application-assembly preparing release 1.14.4 Jul 28, 2017
appng-application-bom preparing release 1.14.4 Jul 28, 2017
appng-application-parent preparing release 1.14.4 Jul 28, 2017
appng-application preparing release 1.14.4 Jul 28, 2017
appng-appngizer-jaxb preparing release 1.14.4 Jul 28, 2017
appng-appngizer-maven-plugin preparing release 1.14.4 Jul 28, 2017
appng-appngizer preparing release 1.14.4 Jul 28, 2017
appng-archetype-application preparing release 1.14.4 Jul 28, 2017
appng-cli preparing release 1.14.4 Jul 28, 2017
appng-core preparing release 1.14.4 Jul 28, 2017
appng-documentation preparing release 1.14.4 Jul 28, 2017
appng-forms preparing release 1.14.4 Jul 28, 2017
appng-formtags preparing release 1.14.4 Jul 28, 2017
appng-mail preparing release 1.14.4 Jul 28, 2017
appng-persistence preparing release 1.14.4 Jul 28, 2017
appng-search preparing release 1.14.4 Jul 28, 2017
appng-standalone preparing release 1.14.4 Jul 28, 2017
appng-taglib preparing release 1.14.4 Jul 28, 2017
appng-template-assembly preparing release 1.14.4 Jul 28, 2017
appng-template-parent preparing release 1.14.4 Jul 28, 2017
appng-testsupport preparing release 1.14.4 Jul 28, 2017
appng-tomcat7 preparing release 1.14.4 Jul 28, 2017
appng-tomcat8 preparing release 1.14.4 Jul 28, 2017
appng-tools preparing release 1.14.4 Jul 28, 2017
appng-xmlapi preparing release 1.14.4 Jul 28, 2017
.gitignore APPNG-2021 Jul 24, 2017
CODE_OF_CONDUCT.adoc APPNG-2004 add code of conduct Jul 4, 2017
CONTRIBUTING.adoc APPNG-2005 update CONTRIBUTING.adoc Jul 4, 2017
LICENSE APPNG-2003 remove APPENDIX from LICENSE file Jul 1, 2017
README.adoc preparing release 1.14.4 Jul 28, 2017
license-header.txt APPNG-2000 Jun 29, 2017
pom.xml preparing release 1.14.4 Jul 28, 2017

README.adoc

appng logo 760px

Welcome to appNG

appNG is a web application platform and a web application framework, based on Apache Tomcat and the Spring Framework.

With appNG, you can build your own applications and deploy them to the platform within minutes.

appNG is very well suited to create and operate your own application platform as a service (aPaaS).

Core Features

  • Clear separation of concerns following the MVC paradigm

  • Declarative UI definition using schema-safe XML files

  • Writing business logic by implementing a handful of interfaces

  • Automatic parameter-binding and type conversion

  • Built-in support for paging, filtering sorting

  • Out-of-the-box support for JPA and Spring Data

  • Built-In connection pooling using HikariCP

  • Database schema migrations powered by Flyway

  • Built-In role based access control, which allows using field-based access

  • Easily provide your own SOAP or REST based webservices

  • Fully supports internationalization (i18n)

  • Easy deployment by providing a repository mechanism

  • Configurable caching powered by Ehcache

  • Cluster support and horizontal scaling

  • Powerful administration tools, including a graphical user interface (GUI), but also a command line interface (CLI) and a REST-client

  • Supports the Bean Validation API

  • Supports indexing and searching, powered by Lucene

  • Customizable templating mechanism

  • Configurable and extendable authentication mechanism (local, LDAP etc.)

  • Provides job scheduling powered by Quartz

  • Provides tooling for common tasks like resizing images, sending emails, geo-locating, report generation etc.

  • Provides a large set of commonly used libraries such as Apache Commons or Jackson

  • Can serve JSP-content that can make use of the appNG tag library

  • Multi-tenancy allows to separate or group applications

  • Rapid protoyping enables you to design your user interface without writing one line of Java code

Getting started

Download and run the appNG standalone Version

appNG is available as a standalone version, suitable for evaluation and testing purposes.

The standalone version also comes with appNGizer, the REST-based administration tool for appNG.

The standalone version can be found here: https://appng.org/appng/builds/stable/appng-standalone-1.14.4.zip

Unzip the file, change into the extracted folder and run

java -jar appng-standalone-1.14.4.jar -i -u

Wait a few seconds, until the console output stops, then visit http://localhost:8080/manager in your browser.

Sign-in with the username admin and the password s3cr3t.

Note

When executing the jar for the next time, you must omit the parameters -u and -i, as they are only allowed on the very first run (-u unpacks and configures the wrapped web applications, -i is for installing the appNG applications and the template).

Create your first appNG application

Using the appNG Maven Archetype, you can easily create your first own application.

Therefore, the following command must be used (replace mygroupid and myartifactid with the desired values):

mvn archetype:generate -DgroupId=mygroupid -DartifactId=myartifactid -DarchetypeGroupId=org.appng -DarchetypeArtifactId=appng-archetype-application -DarchetypeVersion=1.14.4 -DinteractiveMode=false

Next, change into the created project folder and run mvn package.

In the target folder, a file named myartifactid-1.0-SNAPSHOT-<yyyyMMdd-HHmm>.zip should have been generated. This file is the application archive.

Deploying the application

The next step is to deploy the application through a local repository, e.g. the application archives are served from the local file system.

During installation of the appNG standalone version, a local repository has been created at /path/to/appng-standalone-1.14.4/repository/. So the first step is to copy myartifactid-1.0-SNAPSHOT-<yyyyMMdd-HHmm>.zip to this location.

Tip

You can also build the application archive directly in the repository folder by using the Maven option -DoutFolder=/path/to/appng-standalone-1.14.4/repository/

Next, we use the appNG CLI to install the application and to activate it for the site manager (that has been created during installation).

In /path/to/appng-standalone-1.14.4/appng/WEB-INF/bin, execute the following commands:

./appng install-application -n myartifactid -v 1.0-SNAPSHOT -r Local
./appng activate-application -s manager -a myartifactid

Both commands should return without any message, meaning they where successful.

Note

You can also use the appNG Manager or the appNGizer to install and activate an application. To see a list of available CLI commands, execute ./appng or ./appng -h.

If you configure the appNGizer Maven Plugin for your project, you can automatically install and activate your application after the build.

The final step is to reload the site manager. Therefore, login at http://localhost:8080/manager and click on the reload-icon shown next to the site in the overview. A message "Site has been reloaded." should appear.

After a re-login (see details below), a new navigation item named MYAPPLICATION should appear on the site’s navigation on the left. When clicking it, you see the results of your very first appNG application. Congratulations!

Note

During installation, the application’s role Admin has been added to the appNG’s built-in Administrators group, to which your user belongs to. Since the groups of a user are determined once during login, you need to re-login to apply the newly received permissions.

For the following updates of your application, this step is therefore not necessary.

What’s next?

You should import the Maven project into your favorite IDE. Then start browsing the code to get an idea of how an appNG application works. You should also take a look at the Developer Guide.

You may also want to check out appNGizer at http://localhost:8080/appNGizer. The user manual can be found here: https://appng.org/appng/docs/1.15.0-SNAPSHOT/appngizer/html/appngizer-user-manual.html

Components

Name Type Description

appNG

Web application

The appNG platform.

appNGizer

Web application

Provides the appNG REST API. The appNGizer is part of the appng Git Repository. During the build a separate appNGizer WAR file is packaged.

appng-standalone

Standalone version with bundled Tomcat

Includes the applications: Manager, Authentication and Scheduler and also the appNG Template

appNG Manager

appNG core application

Provides a web-based interface to administer appNG and to access other appNG applications.

appNG Authentication

appNG core application

Provides different authentication mechanisms for appNG.

appNG Scheduler

appNG core application

Provides job scheduling services.

appNG Template

appNG template

The classic XSLT based template, used in conjunction with the appNG Manager.

Note
The appNG and appNGizer web applications run in Apache Tomcat, while appNG applications run on the appNG platform. appNG core applications have elevated permissions to access and control the appNG platform. appNG templates define the visual appearance of appNG applications.

Documentation

Component Type Format

appNG

JavaDoc

HTML

appNG

Application Developer Guide

HTML, PDF

appNGizer

Setup Guide

HTML, PDF

appNGizer

Platform installation guide

HTML, PDF

appNGizer

User Manual

HTML, PDF

Download Releases

Component Version Format

appNG

1.14.4

WAR

appNGizer

1.14.4

WAR

Standalone

1.14.4

ZIP

Download Snapshots

Component Version Format

appNG

1.15.0-SNAPSHOT

WAR

appNGizer

1.15.0-SNAPSHOT

WAR

Standalone

1.15.0-SNAPSHOT

ZIP

Warning
Snapshots reflect the current development status. We do not recommend to use snapshots in production and might not be able to help, if you are running cutting-edge appNG. However, if you want to take a look at the latest features, feel free to download a copy and try it out.

Getting help

Please ask your question at Stack Overflow and make sure to add the appng tag to your question.

If you think you found a bug or want to propose a new feature, please create a ticket in our issue tracker.

If you require an Enterprise Support Plan, please contact aiticon GmbH for further information. aiticon also offers trainings, consulting, development and hosting for appNG.

How to contribute

Coming soon.

License

appNG is licensed under the Apache License 2.0.