Starter Apps

To get started with a new application, download one of the two starter apps.

HelloWorld

The helloworld app is a very minimal app, intended just as a starting point to learn what the framework is all about.

The source code is in this git repo which you can either fork, or just download as a zip:

  • to use JPA as the ORM, use:

    curl https://codeload.github.com/apache/causeway-app-helloworld/zip/jpa | jar xv
    cd causeway-app-helloworld-jpa
    
    mvn clean install
    mvn spring-boot:run
  • use JDO as the ORM, use:

    curl https://codeload.github.com/apache/causeway-app-helloworld/zip/jdo | jar xv
    cd causeway-app-helloworld-jdo
    
    mvn clean install
    mvn spring-boot:run
A much more complete explanation of the structure of the app (and how to use it) can be found here.

Simple App

This app has the same functionality as HelloWorld, but is structured so it can be used as a starting point for developing your own applications. It also includes some integration tests, fixtures, and BDD (Cucumber) specs.

The source code can be found in this git repo which you can either fork, or just download as a zip:

  • to use JPA for the ORM, use:

    curl https://codeload.github.com/apache/causeway-app-simpleapp/zip/jpa | jar xv
    cd causeway-app-simpleapp-jpa
    
    mvn clean install
    mvn -pl webapp spring-boot:run
  • to use JDO as the ORM, use:

    curl https://codeload.github.com/apache/causeway-app-simpleapp/zip/jdo | jar xv
    cd causeway-app-simpleapp-jdo
    
    mvn clean install
    mvn -pl webapp spring-boot:run
A much more complete explanation of the structure of the app (and how to use it) can be found here.

Updating to Newer Versions

For both apps you can bump to newer versions of the framework just by updating the <version> of the Parent POM:

pom.xml
<parent>
    <groupId>org.apache.causeway.app</groupId>
    <artifactId>causeway-app-starter-parent</artifactId>
    <version>2.0.0</version>                            (1)
</parent>
1 update as required.

Check the release notes/migration notes for details on new features and of any breaking changes.