Skip to content

Commit

Permalink
* refine README
Browse files Browse the repository at this point in the history
* add steps to build CE jar
  • Loading branch information
hawkchen committed Sep 26, 2024
1 parent 9319e4d commit 548b723
Showing 1 changed file with 37 additions and 34 deletions.
71 changes: 37 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ and mobile applications.
## Resources

### Documentation

* [Tutorial](http://books.zkoss.org/wiki/ZK_Getting_Started/Tutorial)
* [ZK Essentials](http://books.zkoss.org/wiki/ZK_Essentials)
* [ZK Demo](https://www.zkoss.org/zkdemo/)
* [Tutorial](https://www.zkoss.org/documentation#Getting_Started)
* [ZK Essentials](https://books.zkoss.org/zkessentials-book/master/)
* [ZK Developer's Reference](http://books.zkoss.org/wiki/ZK_Developer%27s_Reference)
* [Javadoc API](http://www.zkoss.org/javadoc/latest/zk/)
* [More](http://books.zkoss.org)
* [Documentation](https://www.zkoss.org/documentation)

### Download
### Binary Download

* [Download](http://www.zkoss.org/download/zk/ce)

Expand All @@ -24,45 +24,48 @@ and mobile applications.

### Simply Java

> ZK is renowned for its "Ajax without JavaScript" approach since 2005,
> enabling developers to build rich internet applications transparently
> without any knowledge of Ajax and JavaScript.
Since 2005, ZK has been known for its "Ajax without JavaScript" approach, allowing developers to build rich internet applications without needing knowledge of Ajax or JavaScript.

> The client engine and update engine in ZK play the roles of pitcher and
> catcher, rendering Ajax communication transparent to developers. Events
> triggered by users are encapsulated and marshalled to event listeners
> running at the server.
In ZK, the client engine acts as the pitcher, and the update engine as the catcher, making Ajax communication invisible to the developer. When users trigger events by interacting with UI, ZK automatically encapsulates and sends them to the appropriate event listeners.

> User interface rendered on browsers are surrogated on the server as
> POJO components, alternation made on the POJO components are reflected
> to the client transparently.
User interfaces are rendered in the browser but represented on the server as Plain Old Java Objects (POJO) components. Any changes made to these server-side POJO components are automatically synced to the client-side interface.

> With programs executed at the server, developers can leverage all the Java
> technologies, such as Java EE and Spring, while back-end data and services
> are readily available.
By running code on the server, developers can fully utilize Java technologies such as Java EE and Spring, making it easy to access backend data and services.


### Server+client Fusion

> ZK's Server+client Fusion gives developers the freedom to leverage the best
> of both sides.
ZK's Server+client Fusion gives developers the freedom to leverage the best
of both sides.

> The server-centric solution to Ajax brings a productivity boost, robustness,
> and security to Web application development; while client side solutions
> endows Web applications with greater controllability and the ability to
> leverage client side resources.
The server-centric solution to Ajax brings a productivity boost, robustness,
and security to Web application development; while client side solutions
endows Web applications with greater controllability and the ability to
leverage client side resources.

> ZK marries the benefits of both to bring forth a developer-centric approach
> where developers continue to build large scale enterprise applications with
> all the robustness of Java technologies, but also are offered the flexibility
> to work directly with ZK's jQuery based widgets to further enhance user
> experience.
ZK marries the benefits of both to bring forth a developer-centric approach
where developers continue to build large scale enterprise applications with
all the robustness of Java technologies, but also are offered the flexibility
to work directly with ZK's jQuery based widgets to further enhance user
experience.

### Declarative Programming

> ZK User Interface Markup Language (ZUML) makes the design of rich user interfaces
> as simple as authoring HTML pages. ZUML is a variant of XUL inheriting all
> features available to XML, and separates the UI definition from the run-time logic.
ZK User Interface Markup Language (ZUML) makes the design of rich user interfaces
as simple as authoring HTML pages. ZUML is a variant of XUL inheriting all
features available to XML, and separates the UI definition from the run-time logic.

ZUML also allows developers to automate CRUD between UI components and the data
source with annotations, data binding and MVVM.


> ZUML also allows developers to automate CRUD between UI components and the data
> source with annotations, data binding and MVVM.
# Build Community Edition (CE)
## 1. Set a different version
* run `bin/upver.sh` to update version number in all pom.xml files.
* We recommend you to use a different version number from the official release version to distinguish it from the official release, e.g. add a suffix "-xyz".
## 2. Build CE jar only
* run `./gradlew clean build -x test -x tscheck -x jscheck -PcleanZKOnly=true -PbuildZKOnly=true`
* Need to run `gradlew` to ensure using the expected gradle version
* `-x tscheck -x jscheck` : skip these checking because they requires ZK EE modules
## 3. Install jar into your maven local repository
* run `./gradlew publishToMavenLocal`

0 comments on commit 548b723

Please sign in to comment.