Userback Widgets

A JavaScript widget package for integrating Userback.io npm packages

Package

This repository contains the core package:

• @userback/widget – A lightweight JavaScript widget for collecting user feedback via Userback.io.

It also includes example integrations for popular frameworks like React, Vue, and Vanilla JS to help you quickly get started in your own project.

Getting Started

To get started with installation and usage instructions, visit the @userback/widget package on npm.

Developing and running examples

After cloning the repo, you can install all dependencies and build the widgets with: yarn && yarn build

After which you can run an example package using yarn start:widget or yarn start:react.

To provide your api token, create a .env file containing your Userback api key like the following:

VITE_UB_TOKEN=XXXxxxXXX

End to End Testing

Test coverage is mainly achieved through playwright and docker compose. In order to run the e2e test suite run the following:

yarn test:docker

Documentation

Refer to each of the packages listed above for framework specific documentation and examples. For more information about available configuration settings and and functions available, see our Javascript API

Release Process

1. Checkout develop against the commit you plan to release.
2. Build a production build with yarn build.
3. Ensure CI is green and Local testing are successful (eg: yarn test).
4. Update all versions with yarn version:all (major/minor/patch).
5. git commit -m "vX.X.X" and git tag vX.X.X where X.X.X is your new version.
6. yarn publish to publish all packages to the npm repo.
7. git push && git push --tags to push the release to github.
8. Create a github release 🎉