Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samie/nps
Net Promoter Score widget for Java
https://github.com/samie/nps
java net-promoter-score nps vaadin
Last synced: 15 days ago
JSON representation
Net Promoter Score widget for Java
- Host: GitHub
- URL: https://github.com/samie/nps
- Owner: samie
- License: other
- Created: 2023-04-26T11:59:03.000Z (over 1 year ago)
- Default Branch: v24
- Last Pushed: 2024-02-22T09:05:47.000Z (10 months ago)
- Last Synced: 2024-10-17T19:16:15.748Z (2 months ago)
- Topics: java, net-promoter-score, nps, vaadin
- Language: Java
- Homepage:
- Size: 182 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NPS widget for Vaadin
This is a reusable NPS [Net Promoter Score](https://en.wikipedia.org/wiki/Net_promoter_score) widget. The widget displays a numeric scale typically ranging from 0 to 10, allowing users to rate their experience or likelihood to recommend on a continuum.
The widget is available in Vaadin Directory: [vaadin.com/directory/component/nps](https://vaadin.com/directory/component/nps).
Additionally the demo project implements a full application for collecting and reporting the NPS score. This can be used as standalone application to collect user feedback. This application is a runnable Spring Boot web application using Vaadin.
NPS focuses on collecting user feedback, providing you with valuable insights to gauge customer satisfaction and loyalty. While it doesn't generate reports directly, the data collected by the widget can be used to analyze and measure the overall sentiment and make informed decisions to enhance your product or service based on the feedback received.
## Project structure
Project consists of two modules:
- [addon](addon/) - Vaadin NPS component itself.
- [demo](demo/) - Application demmostrating the usage of the component.
## Add-on architecture
This add-on is server-side only implementation made using existing Vaadin components.
## Development instructions
### Important Files
* NPS.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.
### Mannually running the add-on tests
Starting the test server in addon module:
```
cd addon
mvn jetty:run
```
This deploys demo at http://localhost:8080
### Integration test
To run Integration Tests, execute `mvn verify -Pit,production` in `addon` module.
## Publishing to Vaadin Directory
Project uses Directory REST API to publish the addon.
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