demo-helper-view Add-on for Vaadin 12

demo-helper is a UI component add-on for Vaadin 12 to assist you in creating visually appealing demos including code examples in a short amount of time.

Online demo

Try the add-on demo

Download release

Official releases of this add-on are available at Vaadin Directory. For Maven instructions, download and reviews, go to https://vaadin.com/directory/component/demo-helper-add-on

Building and running demo

git clone https://github.com/appreciated/demo-helper-view/
mvn clean install
cd demo
mvn jetty:run

To see the demo, navigate to http://localhost:8080/

Importing project

Choose File > Import... > Existing Maven Projects

Note that Eclipse may give "Plugin execution not covered by lifecycle configuration" errors for pom.xml. Use "Permanently mark goal resources in pom.xml as ignored in Eclipse build" quick-fix to mark these errors as permanently ignored in your project. Do not worry, the project still works fine.

Debugging server-side

If you have not already compiled the widgetset, do it now by running vaadin:install Maven target for demo-helper-root project.

If you have a JRebel license, it makes on the fly code changes faster. Just add JRebel nature to your demo-helper-demo project by clicking project with right mouse button and choosing JRebel > Add JRebel Nature

To debug project and make code modifications on the fly in the server-side, right-click the demo-helper-demo project and choose Debug As > Debug on Server. Navigate to http://localhost:8080/ to see the application.

Debugging client-side

Debugging client side code in the demo-helper-demo project:

run "mvn vaadin:run-codeserver" on a separate console while the application is running
activate Super Dev Mode in the debug window of the application or by adding ?superdevmode to the URL
You can access Java-sources and set breakpoints inside Chrome if you enable source maps from inspector settings.

Issue tracking

The issues for this add-on are tracked on its github.com page. All bug reports and feature requests are appreciated.

Contributions

Contributions are welcome, but there are no guarantees that they are accepted as such. Process for contributing is the following:

Fork this project
Create an issue to this project about the contribution (bug or feature) if there is no such issue about it already. Try to keep the scope minimal.
Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
Refer to the fixed issue in commit
Send a pull request for the original project
Comment on the original issue that you have implemented a fix for it

License & Author

Add-on is distributed under Apache License 2.0. For license terms, see LICENSE.txt.

demo-helper-view is written by appreciated

Features

API

demo-helper-view JavaDoc is not yet available

appreciated / demo-helper-view

readme