https://github.com/botpress/bp-report
Custom Module for reporting issues
https://github.com/botpress/bp-report
Last synced: about 1 year ago
JSON representation
Custom Module for reporting issues
- Host: GitHub
- URL: https://github.com/botpress/bp-report
- Owner: botpress
- Created: 2022-08-17T00:16:54.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-08-31T13:57:45.000Z (almost 4 years ago)
- Last Synced: 2025-02-15T14:47:34.433Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 61.3 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Botpress Issue Reporter
This is a custom module that allows you to quickly and easily share issues with your conversations in botpress with your team or with the botpress team.
Note: issues are public, so make sure to only use this while in development.
## Example
You can report anything, bugs or incorrect wordings, and you'll get a shareable link for your work.
## Setting it up
1. Download [bp-report.tgz](./custom_module/bp-report.tgz)
2. In Botpress go to the modules configuration page
3. Click upload module
4. select the download tgz file
5. submit.
6. restart the server
7. unpack the module
8. activate the module by toggling it on
9. restart botpress
### (optional) add slack notification
1. create a webhook on slack [slack webhook docs](https://api.slack.com/messaging/webhooks)
2. open the code editor
3. open modules/bp-report.json
4. paste the webhook url as a value for someEndpoint
5. restart botpress
## to use it
1. in any conversation type "bp_report" to report an issue to us,
2. type in a description of the issue
3. You'll get a link to the conversation information and optionally a notification in slack.
## to rebuild it
1. install quasar `yarn global add @quasar/cli` or `npm i -g @quasar/cli`
2. `npm i` in frontend and custom_module folders
3. make changes (dashboard code is in [frontend](./frontend) and hooks are in [custom_module/src/hooks](./custom_module/src/hooks))
4. `. ./build.sh`
5. The custom module will be found in [bp-report.tgz](./bp-report.tgz).