ZK Spring Boot Starter

https://github.com/zkoss/zkspringboot
Admin
ZK Spring Boot Starter is an integration between the ZK Java web framework and Spring Boot that...
Tokens:1,640
Snippets:31
Trust Score:9.4
License:Apache-2.0
Update:2 months ago
Show doc for...
Tokens:
Raw
### Run a demo application

Source: https://github.com/zkoss/zkspringboot/blob/master/GEMINI.md

Navigate to a specific demo directory and execute this command to start the application using the Spring Boot Maven plugin.

```bash
mvn spring-boot:run
```

--------------------------------

### Build the project with Maven

Source: https://github.com/zkoss/zkspringboot/blob/master/GEMINI.md

Execute this command from the root directory to clean and install the project modules.

```bash
mvn clean install
```

--------------------------------

### Spring MVC Mapping for ZK View

Source: https://github.com/zkoss/zkspringboot/blob/master/README.md

Example of a Spring MVC controller method mapping a path to a ZUL view name.

```java
	@GetMapping("/demo")
	public String demo() {
		return "views/demo";
	}
```

--------------------------------

### Build and Run Demos with Gradle

Source: https://github.com/zkoss/zkspringboot/blob/master/zkspringboot-demos/README.md

Commands to build all projects or run specific demo modules using the Gradle wrapper.

```bash
./gradlew clean build
```

```bash
./gradlew zkspringboot-minimal-jar:bootRun
./gradlew zkspringboot-minimal-war:bootRun
./gradlew zkspringboot-demo-jar:bootRun
./gradlew zkspringboot-security-demo:bootRun
```

```bash
cd zkspringboot-demo-jar
../gradlew bootRun
```

--------------------------------

### Build and Run Demos with Maven

Source: https://github.com/zkoss/zkspringboot/blob/master/zkspringboot-demos/README.md

Commands to build all projects or run specific demo modules using the Maven wrapper.

```bash
./mvnw clean test
./mvnw clean package -DskipTests
```

```bash
./mvnw spring-boot:run -pl zkspringboot-minimal-jar
./mvnw spring-boot:run -pl zkspringboot-minimal-war
./mvnw spring-boot:run -pl zkspringboot-demo-jar
./mvnw spring-boot:run -pl zkspringboot-security-demo
```

```bash
cd zkspringboot-demo-jar
../mvnw spring-boot:run
```

--------------------------------

### Configure ZK for Spring Boot DevTools

Source: https://github.com/zkoss/zkspringboot/blob/master/README.md

Add this property to META-INF/spring-devtools.properties to ensure ZK jars are included in the restart classloader.

```properties
restart.include.zklibs=/z[\\w]+-[\\w\\d-\\.]+\\.jar
```

--------------------------------

### Enable Debug Mode for Spring Boot WAR

Source: https://github.com/zkoss/zkspringboot/blob/master/README.md

Use these JVM arguments when running the application via Maven to enable remote debugging.

```bash
mvn spring-boot:run -Dspring-boot.run.jvmArguments="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=*:5005"
```

--------------------------------

### Default ZK Spring Boot Properties

Source: https://github.com/zkoss/zkspringboot/blob/master/README.md

Default configuration values for ZK Spring Boot applications as defined in ZkProperties.java.

```properties
zk.springboot-packaging=jar

zk.homepage=
zk.zul-view-resolver-enabled=true
zk.zul-view-resolver-prefix=
zk.zul-view-resolver-suffix=.zul

zk.richlet-filter-mapping=

zk.websockets-enabled=true
zk.servlet3-push-enabled=true
zk.update-uri=/zkau
```
Tokens:
Raw