Documentation

hpehl · hpehl · commit 22a97ae71c33 · 2024-04-10T16:45:06.000+02:00
diff --git a/README.md b/README.md
@@ -81,7 +81,7 @@ depending on your stack. If you're using GWT, inherit from `org.patternfly.Patte
 
 PatternFly Java has no external JavaScript dependencies. Everything necessary is included in the code base for both GWT and J2CL. However, Patternfly Java does **not** come with stylesheets. You are expected to include or bundle the necessary stylesheets yourself. Take a look at the PatternFly [getting started guide](https://www.patternfly.org/get-started/develop#htmlcss) for more information.
 
-You can also take a look at the code of the showcase for [GWT](https://github.com/patternfly-java/patternfly-java/tree/main/showcase/gwt) and [J2CL](https://github.com/patternfly-java/patternfly-java/tree/main/showcase/j2cl) to see how to setup and use PatternFly Java.
+You can also take a look at the code of the [showcase]https://github.com/patternfly-java/patternfly-java/tree/main/showcase#readme for [GWT](https://github.com/patternfly-java/patternfly-java/tree/main/showcase/gwt) and [J2CL](https://github.com/patternfly-java/patternfly-java/tree/main/showcase/j2cl) to see how to setup and use PatternFly Java.
 
 # Modules
 
diff --git a/showcase/README.md b/showcase/README.md
@@ -1,5 +1,69 @@
 # PatternFly Java Showcase
 
-The showcase for PatternFly Java is inspired by the [PatternFly](https://www.patternfly.org/) website. It provides pages for all supported components, layouts and extensions.
+The [showcase](https://patternfly-java.github.io/) for PatternFly Java is inspired by the [PatternFly](https://www.patternfly.org/) website. It provides pages for all supported components, layouts and extensions.
 
-The bulk of the showcase code is in the `common` module. The
+The bulk of the showcase code is in the [`common`](https://github.com/patternfly-java/patternfly-java/tree/main/showcase/common) module. The `gwt` and `j2cl` modules contain just some bootstrapping code and depend on the `common` module.
+
+# Build
+
+To build the showcase follow theses steps
+
+## GWT
+
+### Development Mode
+
+```shell
+cd $PATTERNFLY_JAVA_HOME
+mvn -Dquickly install
+cd showcase/gwt
+mvn gwt:devmode
+open http://localhost:8888/showcase
+```
+
+### Production Mode
+
+```shell
+cd $PATTERNFLY_JAVA_HOME
+mvn --projects org.patternfly:patternfly-java-showcase-gwt --also-make -P prod,showcase install
+```
+
+The compiled HTML, JavaScript and CSS filed are in `showcase/gwt/target/patternfly-java-showcase-gwt-<version>-gwt-app`. Please use a local HTTP server like https://www.npmjs.com/package/http-server open the showcase:
+
+```shell
+http-server showcase/gwt/target/patternfly-java-showcase-gwt-0.2.2-SNAPSHOT-gwt-app
+open http://localhost:8080/showcase
+```
+
+## J2CL
+
+### Development Mode
+
+```shell
+cd $PATTERNFLY_JAVA_HOME
+mvn --projects org.patternfly:patternfly-java-showcase-j2cl --also-make -P showcase j2cl:watch
+```
+
+In another shell execute
+
+```shell
+cd $PATTERNFLY_JAVA_HOME/showcase/j2cl
+yarn run watch
+```
+
+### Production Mode
+
+```shell
+cd $PATTERNFLY_JAVA_HOME
+mvn --projects org.patternfly:patternfly-java-showcase-j2cl --also-make -P prod,showcase install
+```
+
+The compiled HTML, JavaScript and CSS filed are in `showcase/j2cl/target/showcase`. Please use a local HTTP server like https://www.npmjs.com/package/http-server open the showcase:
+
+```shell
+http-server showcase/j2cl/target/showcase
+open http://localhost:8080
+```
+
+# Feedback
+
+Please let me know if you have troublw building the showcase. File an [issue](https://github.com/patternfly-java/patternfly-java/issues/new) or join the [chat](https://app.gitter.im/#/room/#pf4-java_core:gitter.im).
