https://github.com/vaadin-component-factory/pivot-table-flow
https://github.com/vaadin-component-factory/pivot-table-flow
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/vaadin-component-factory/pivot-table-flow
- Owner: vaadin-component-factory
- License: other
- Created: 2022-09-14T08:08:32.000Z (over 2 years ago)
- Default Branch: v23
- Last Pushed: 2024-01-27T20:41:15.000Z (over 1 year ago)
- Last Synced: 2025-01-10T00:36:32.957Z (5 months ago)
- Language: Java
- Size: 544 KB
- Stars: 1
- Watchers: 7
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vaadin Add-on example project
An empty project for creating a Vaadin add-on. You should start from this project if your add-on's components are based on the existing Vaadin classes or doesn't use 3rd party JavaScript modules. For creating a wrapper for a JS module you might want to use the [Component Starter](https://github.com/vaadin/component-starter-flow) repository as a template instead.
## Development instructions
### Important Files
* TheAddon.java: this is the addon-on component class. You can add more classes if you wish, including other Components.
* TestView.java: A View class that let's you test the component you are building. This and other classes in the test folder will not be packaged during the build. You can add more test view classes in this package.
* assembly/: this folder includes configuration for packaging the project into a JAR so that it works well with other Vaadin projects and the Vaadin Directory. There is usually no need to modify these files, unless you need to add JAR manifest entries.
If you are using static resources such as images, JS (e.g. templates) and CSS files the correct location for them is under the `/src/main/resources/META-INF/resources/frontend` directory and is described here [Resource Cheat Sheet](https://vaadin.com/docs/v14/flow/importing-dependencies/tutorial-ways-of-importing.html#resource-cheat-sheet)in more details.
### Deployment
Starting the test/demo server:
```
mvn jetty:run
```
This deploys demo at http://localhost:8080
### Integration test
To run Integration Tests, execute `mvn verify -Pit,production`.
## Publishing to Vaadin Directory
You should change the `organisation.name` property in `pom.xml` to your own name/organization.
```
###author###
```
You can create the zip package needed for [Vaadin Directory](https://vaadin.com/directory/) using
```
mvn versions:set -DnewVersion=1.0.0 # You cannot publish snapshot versions
mvn install -Pdirectory
```
The package is created as `target/{project-name}-1.0.0.zip`
For more information or to upload the package, visit https://vaadin.com/directory/my-components?uploadNewComponent