Commit 22a97ae
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -81,7 +81,7 @@ depending on your stack. If you're using GWT, inherit from `org.patternfly.Patte | |||
| 81 | 81 | ||
| 82 | 82 | 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. | |
| 83 | 83 | ||
| 84 | - 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. | ||
| 84 | + 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. | ||
| 85 | 85 | ||
| 86 | 86 | # Modules | |
| 87 | 87 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,5 +1,69 @@ | |||
| 1 | 1 | # PatternFly Java Showcase | |
| 2 | 2 | ||
| 3 | - 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. | ||
| 3 | + 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. | ||
| 4 | 4 | ||
| 5 | - The bulk of the showcase code is in the `common` module. The | ||
| 5 | + 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. | ||
| 6 | + | ||
| 7 | + # Build | ||
| 8 | + | ||
| 9 | + To build the showcase follow theses steps | ||
| 10 | + | ||
| 11 | + ## GWT | ||
| 12 | + | ||
| 13 | + ### Development Mode | ||
| 14 | + | ||
| 15 | + ```shell | ||
| 16 | + cd $PATTERNFLY_JAVA_HOME | ||
| 17 | + mvn -Dquickly install | ||
| 18 | + cd showcase/gwt | ||
| 19 | + mvn gwt:devmode | ||
| 20 | + open http://localhost:8888/showcase | ||
| 21 | + ``` | ||
| 22 | + | ||
| 23 | + ### Production Mode | ||
| 24 | + | ||
| 25 | + ```shell | ||
| 26 | + cd $PATTERNFLY_JAVA_HOME | ||
| 27 | + mvn --projects org.patternfly:patternfly-java-showcase-gwt --also-make -P prod,showcase install | ||
| 28 | + ``` | ||
| 29 | + | ||
| 30 | + 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: | ||
| 31 | + | ||
| 32 | + ```shell | ||
| 33 | + http-server showcase/gwt/target/patternfly-java-showcase-gwt-0.2.2-SNAPSHOT-gwt-app | ||
| 34 | + open http://localhost:8080/showcase | ||
| 35 | + ``` | ||
| 36 | + | ||
| 37 | + ## J2CL | ||
| 38 | + | ||
| 39 | + ### Development Mode | ||
| 40 | + | ||
| 41 | + ```shell | ||
| 42 | + cd $PATTERNFLY_JAVA_HOME | ||
| 43 | + mvn --projects org.patternfly:patternfly-java-showcase-j2cl --also-make -P showcase j2cl:watch | ||
| 44 | + ``` | ||
| 45 | + | ||
| 46 | + In another shell execute | ||
| 47 | + | ||
| 48 | + ```shell | ||
| 49 | + cd $PATTERNFLY_JAVA_HOME/showcase/j2cl | ||
| 50 | + yarn run watch | ||
| 51 | + ``` | ||
| 52 | + | ||
| 53 | + ### Production Mode | ||
| 54 | + | ||
| 55 | + ```shell | ||
| 56 | + cd $PATTERNFLY_JAVA_HOME | ||
| 57 | + mvn --projects org.patternfly:patternfly-java-showcase-j2cl --also-make -P prod,showcase install | ||
| 58 | + ``` | ||
| 59 | + | ||
| 60 | + 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: | ||
| 61 | + | ||
| 62 | + ```shell | ||
| 63 | + http-server showcase/j2cl/target/showcase | ||
| 64 | + open http://localhost:8080 | ||
| 65 | + ``` | ||
| 66 | + | ||
| 67 | + # Feedback | ||
| 68 | + | ||
| 69 | + 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). | ||
0 commit comments