quick-bug-reporter-react 1.5.0 → 1.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +57 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -85,6 +85,63 @@ That's it — a floating "Report Bug" button appears in the bottom-right corner.
|
|
|
85
85
|
|
|
86
86
|
## Integrations
|
|
87
87
|
|
|
88
|
+
### QuickBugs Cloud (Recommended)
|
|
89
|
+
|
|
90
|
+
The **CloudIntegration** forwards bug reports to the QuickBugs dashboard, which automatically syncs them to your connected Jira/Linear workspace. This is the **simplest setup** - no proxy endpoints required.
|
|
91
|
+
|
|
92
|
+
```ts
|
|
93
|
+
import { CloudIntegration } from "quick-bug-reporter-react";
|
|
94
|
+
|
|
95
|
+
const cloud = new CloudIntegration({
|
|
96
|
+
projectKey: "your-project-key", // from QuickBugs dashboard
|
|
97
|
+
endpoint: "https://your-dashboard.com/api/ingest", // optional, defaults to "/api/ingest"
|
|
98
|
+
});
|
|
99
|
+
|
|
100
|
+
export default function App({ children }) {
|
|
101
|
+
return (
|
|
102
|
+
<BugReporterProvider
|
|
103
|
+
integrations={{ cloud }}
|
|
104
|
+
defaultProvider="cloud"
|
|
105
|
+
>
|
|
106
|
+
{children}
|
|
107
|
+
<FloatingBugButton />
|
|
108
|
+
<BugReporterModal />
|
|
109
|
+
</BugReporterProvider>
|
|
110
|
+
);
|
|
111
|
+
}
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
| Option | Description |
|
|
115
|
+
|--------|-------------|
|
|
116
|
+
| `projectKey` | Your project key from QuickBugs dashboard (**required**) |
|
|
117
|
+
| `endpoint` | Dashboard ingest URL (defaults to `/api/ingest`) |
|
|
118
|
+
| `fetchImpl` | Custom fetch implementation |
|
|
119
|
+
|
|
120
|
+
**Benefits:**
|
|
121
|
+
- ✅ No proxy endpoints to maintain
|
|
122
|
+
- ✅ Centralized bug tracking and analytics
|
|
123
|
+
- ✅ Automatic forwarding to Jira/Linear
|
|
124
|
+
- ✅ 7-day file retention (files forwarded immediately)
|
|
125
|
+
- ✅ Structured bug reports with automatic formatting
|
|
126
|
+
|
|
127
|
+
**During development**, set up a proxy in your bundler to forward `/api/ingest` to your dashboard:
|
|
128
|
+
|
|
129
|
+
```ts
|
|
130
|
+
// vite.config.ts
|
|
131
|
+
export default defineConfig({
|
|
132
|
+
server: {
|
|
133
|
+
proxy: {
|
|
134
|
+
'/api/ingest': {
|
|
135
|
+
target: 'http://localhost:3000', // your dashboard URL
|
|
136
|
+
changeOrigin: true,
|
|
137
|
+
},
|
|
138
|
+
},
|
|
139
|
+
},
|
|
140
|
+
});
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
---
|
|
144
|
+
|
|
88
145
|
### Jira
|
|
89
146
|
|
|
90
147
|
```ts
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "quick-bug-reporter-react",
|
|
3
|
-
"version": "1.5.
|
|
3
|
+
"version": "1.5.1",
|
|
4
4
|
"description": "Drop-in bug reporter for React apps — screenshot, video capture, annotation, and Linear/Jira integration.",
|
|
5
5
|
"author": "Ali Abdulkadir Ali",
|
|
6
6
|
"homepage": "https://github.com/AAALI/bug-reporter-react#readme",
|