Create and Run ZK Application with Maven Artifacts

If you are first to Maven, please refer to Create and Run ZK Application with Maven Archetype because it is easy to follow. This article is more helpful for users who already have a Maven project and/or want to handle some of the configuration files manually.

How to create ZK Maven web project

ZK Maven Project Hierarchy

Create Project of Maven

• [File] -> [New] -> [Other] --> [Maven Project]

  

• Check Create a simple Project

  

• Fill the first 4 field (you can change them later) --> Click [Finish]

  Group Id is usually the package name but it could be anything you prefer. Here we use org.zkoss, but it is better to use your own.

  Arifact Id is your project's ID.

  Version is your project's version.

  

Add WTP Support (Project Facet)

1. Create new folder under /src/main/ named webapp
2. Right Click on your Maven Project -> Choose Properties -> Choose Project Facets -> Check Dynamic Web Module

   Note: if it showing Covert facet from..., simply click it to enable facet.

   

3. Click Further configuration available' --> input the Context Root and Content Directory --> Check Generate web.xml deployment descriptor

   

Enable Dependency and Web Project configuration

web.xml

• Overwrite the content of /src/main/webapp/WEB-INF/web.xml with Sample of web.xml.

pom.xml

• Overwrite the content of pom.xml with Sample of pom.xml

How to run Maven project on Run-Jetty-Run (Optional)

Notice that Run-Jetty-Run is optional. The speed of deployment is much faster, but the server is Jetty embedded in Run-Jetty-Run. If you prefer to use your own server, you could skip this step.

1. Create new zul file index.zul under /src/main/webapp
2. Goto Run Configurations

   

3. Double click on Jetty Webapp
   • It will auto fill Project / Port / Context / WebApp Dir

   

4. Click Run and browse http://127.0.0.1:8080/TestMavenWebProject/

---