Quick Start
This chapter describes how to quickly start your first ZK application. Pick the setup that matches the tools you already use — every option ends with the same running ZK page.
If you are not sure, use First ZK App with Maven Archetype. It needs only Java and Maven, and works the same on every operating system and in every IDE.
Choose Your Setup
- First ZK App with Maven Archetype — command line, no IDE required
- First ZK App with IntelliJ and ZKIdea — includes the ZK plugin with ZUL completion and layout preview
- First ZK App with Eclipse and Maven
- First ZK App with Eclipse and ZK Studio
- First ZK App with Gradle
- First ZK App with Spring Boot
- First ZK App with Visual Studio Code
- First ZK App with NetBeans and REM
- First ZK App Manually — no build tool, for understanding what the jars and
web.xmlactually do
Not Ready to Set Up a Project?
Two ways to write ZK code before you install anything:
- ZKFiddle runs ZUL and Java in your browser. Good for trying a component or reproducing a problem.
- Clone the tutorial project and run it with one command — no Maven installation needed:
Prefer to start from working code?
Clone the example project and run it with a single command —
./mvnw jetty:run — no Maven installation needed.
Docker, Windows and WAR options are covered in the README.