Create and Run Your First ZK Application with Gradle"
Robertwenzel (talk | contribs) |
Robertwenzel (talk | contribs) |
||
Line 44: | Line 44: | ||
./gradlew tasks | ./gradlew tasks | ||
− | '''NOTE''': Using the windows command line (''cmd'') you | + | '''NOTE''': Using the windows command line (''cmd'') you have to omit the "./" in front of the commands e.g. |
gradlew clean | gradlew clean | ||
Revision as of 10:41, 15 March 2017
The zk-gradle example
To use the zk-gradle example project all you need is a command line interface (and optional: git).
Since gradle is a complex tool a basic understanding about gradle itself will help understanding the example -> please refer to the gradle documentation pages.
Download/Clone the example project
with git command line installed all you need is to clone the example repository:
git clone [email protected]:zkoss-demo/zk-gradle.git
Alternatively you can download the example as a zip-package.
Once cloned/unzipped open a command line tool in the project folder.
In order to get started immediately the project includes the gradle-wrapper. The wrapper comes with 2 scripts gradlew.bat (windows) and gradlew (linux/mac) and a folder /gradle containing a laucher jar which will download gradle itself with all its required dependencies without having to install gradle manually.
The first time you'll execute any of the commands in the following section gradle will download itself and all the required project dependencies. This will initially take quite a few minutes while showing the overall progress. Subsequent executions will be faster as gradle will cache the once downloaded resources in the .gradle/ subfolder (it's safe to delete this folder, gradle will just download the dependencies again next time it is executed)
build.gradle the build script [1]
settings.gradle the build settings e.g. contains the project name [2]
gradle.properties here contains the dependency versions [3]
Useful build tasks
build the war file (in the subfolder build/libs/zk-gradle.war)
./gradlew war
run the unit tests (also creates a test report in build/reports/tests/test/index.html)
./gradlew test
combine both
./gradlew test war
clean the build
./gradlew clean
list available tasks (show many more options ...)
./gradlew tasks
NOTE: Using the windows command line (cmd) you have to omit the "./" in front of the commands e.g.
gradlew clean
Run the Project
The example project uses the gradle build plugin gretty, which allows running the program with the command below:
./gradlew appRun
Once you see the following output:
17:32:19 INFO Jetty 9.2.15.v20160210 started and listening on port 8080 17:32:19 INFO zk-gradle runs at: 17:32:19 INFO http://localhost:8080/zk-gradle Press any key to stop the server.
The server has started and you can access the test page under:
http://localhost:8080/zk-gradle
Import a Gradle project into your IDE
The example project doesn't include or require any IDE specific settings and can be imported into your preferred IDE supporting gradle.
In Eclipse you can use the buildship plugin
For IntelliJ IDEA just follow the Help page: Working with Gradle Projects