@nixfo/bugular v0.0.1-alpha
Bugular
Bugular is a library providing a ready-to-use component to report bugs on the screen. When clicking on the Bugular Report button, the user can choose the screen/window to capture, then send the report to the server with a comment.
How to use
Bugular is really simple to set up. You can include the button component with <bugular-button></bugular-button>.
All you have to do then is to set the token key injecting BugularService, then calling setToken(YOUR_TOKEN).
Prerequisite
You need to install the peerDependencies of the library :
| peerDependency | version |
|---|---|
| @angular/common | >=13.3.0 |
| @angular/core | >=13.3.0 |
| @angular/forms | >=13.3.0 |
| jwt-decode | ^3.1.2 |
Build
Run npm run build to build the project. The build artifacts will be stored in the dist/ directory.
Testing
Build the project (previous step), go to the dist folder cd dist/bugular and run npm pack.
The library can be imported locally in npm via this line in the target package.json "bugular": "file:path_to_pack
Running unit tests
Run npm run test to execute the unit tests via Karma.
Publishing
After building the library with npm run build, go to the dist folder cd dist/bugular and run npm publish.
Further help
For further help, you can create an issue on the GitHub repository.