@bugfreedback/bugfreedback

bugfreedback

Nuxt feedback widget with screen capture, annotation, pluggable screenshot storage (GCS / S3), and modular export adapters (GitHub, Linear, Jira, Notion, Slack, Asana, Trello, Webhook, IFTTT).

• Package: @bugfreedback/bugfreedback
• Docs: https://bugfreedback.github.io/bugfreedback/
• Repo: bugfreedback/bugfreedback

Quick start

Install the module and its peer dependency:

npm install @bugfreedback/bugfreedback @nuxt/ui

// nuxt.config.ts
export default defineNuxtConfig({
  modules: ['@nuxt/ui', '@bugfreedback/bugfreedback'],
  bugfreedback: {
    enabled: true,
    storage: { provider: 'gcs', bucket: process.env.BUGFREEDBACK_GCS_BUCKET! },
    export: {
      provider: 'github',
      token: process.env.BUGFREEDBACK_GITHUB_TOKEN!,
      owner: 'your-org',
      repo: 'your-repo',
    },
  },
})

<!-- layouts/default.vue -->
<template>
  <div>
    <slot />
    <BugfreedbackHost />
  </div>
</template>

See the getting started guide for auth, theming, and adapter configuration.

Development

npm install
npm run dev:prepare
npm run dev          # playground
npm test
npm run docs:dev     # VitePress site

Maintainers: see RELEASING.md for version bumps and npm publish.

Docs & demo: npm run docs:dev · npm run dev (playground at http://localhost:3000)

License

MIT