Creating Java WebApp with J-Framework-Web and Git

Last updated: 2025-09-14

The requirement of having Git Data Access is limited to very few use-cases and not designed to be scalable. Use-cases includes configuration management and data that needs to be versioned and rollbacked, so be sure to know when to use it.

J-Framework Web project simplifies building Java database driven web applications based on JSF and PrimeFaces and Git. This example will create CRUD (Create, Read, Update, Delete) operations of Person information.

Pre-Requisite:

  1. Create GitHub Repository

  2. Create GitHub Access Token

  3. Have the repository url, branch, username,and password (or preferably access token) ready

If you have enabled 2-factor authentication on your Git account, you need to create a Personal Access Token and use it as your password.

Steps:

  1. Create Maven project with the following pom.xml:

Unresolved include directive in modules/6.x.x/pages/frameworks/jk-framework/jk-framework-webstack/java-web-jsf-git-tutorial.adoc - include::inc/git/pom.xml[]

If you are using Eclipse, be sure to refresh your project (select your project→ right click→ Maven→ Update Project)

  1. Create config file at src/main/resources/config.properties with the following contents:

Unresolved include directive in modules/6.x.x/pages/frameworks/jk-framework/jk-framework-webstack/java-web-jsf-git-tutorial.adoc - include::inc/git/src/main/resources/config.properties[]

  1. Create Model class at src/main/java/com/app/person/Model.java with the following contents:

Unresolved include directive in modules/6.x.x/pages/frameworks/jk-framework/jk-framework-webstack/java-web-jsf-git-tutorial.adoc - include::inc/git/src/main/java/com/app/person/Model.java[]

  1. Create DataAccess class at src/main/java/com/app/person/DataAccess.java with the following contents:

Unresolved include directive in modules/6.x.x/pages/frameworks/jk-framework/jk-framework-webstack/java-web-jsf-git-tutorial.adoc - include::inc/git/src/main/java/com/app/person/DataAccess.java[]

  1. Create controller (JSF Managed Bean) at src/main/java/com/app/person/Controller.java with the following contents:

Unresolved include directive in modules/6.x.x/pages/frameworks/jk-framework/jk-framework-webstack/java-web-jsf-git-tutorial.adoc - include::inc/git/src/main/java/com/app/person/Controller.java[]

  1. Create JSF XHTML Page at src/main/webapp/index.xhtml class with the following contents:

Unresolved include directive in modules/6.x.x/pages/frameworks/jk-framework/jk-framework-webstack/java-web-jsf-git-tutorial.adoc - include::inc/git/src/main/webapp/pages/person/full.xhtml[]

  1. Create App class at src/main/java/com/app/App.java with the following contents:

Unresolved include directive in modules/6.x.x/pages/frameworks/jk-framework/jk-framework-webstack/java-web-jsf-git-tutorial.adoc - include::inc/git/src/main/java/com/app/App.java[]

Thats it, now run your App class, in few seconds your browser will open and you should see something like this:

Output

Full example source-code can be found at https://github.com/smartapi-com/j-framework-web-git