Quickstart

Every path below ends with a real, labelled GitHub issue in your repo. Pick your platform.

Apple (Swift)

1. Add the package (see Installation), importing AppFeedbackCore (and AppFeedbackUI for the drop-in sheet).

2. Build a client once at app start:

   import AppFeedbackCore
   
   let feedback = FeedbackClient(
     appName: "Acme",
     transport: GitHubDirectTransport(owner: "acme", repo: "feedback", token: token)
   )

3. Submit a report:

   let issueNumber = try await feedback.submit(
     FeedbackReport(type: .bug, title: "Crash on launch", description: "Steps to reproduce…")
   )

4. Or present the drop-in SwiftUI sheet:

   import AppFeedbackUI
   
   .sheet(isPresented: $showFeedback) {
     FeedbackSheet(client: feedback, theme: .default)
   }

Where does the token live?

A GitHubDirectTransport token stays in the app’s Keychain — acceptable for a signed native app. For higher volume, point a custom transport at a relay you control. See the security model.

Web (TypeScript)

The web SDK never holds a GitHub token — it talks to a relay you deploy.

1. Deploy a relay (one function — Cloudflare / Vercel / Firebase / Appwrite). See The relay.

2. Install and mount the widget:

   import { mountFeedbackWidget } from '@appfeedback/widget'
   import { RelayTransport } from '@appfeedback/core'
   
   mountFeedbackWidget(document.getElementById('feedback')!, {
     transport: new RelayTransport({ endpoint: '/api/feedback' }),
     appName: 'Acme',
     appVersion: '1.0.0',
   })

3. React app? Use the component instead:

   import { FeedbackForm } from '@appfeedback/react'
   
   <FeedbackForm
     transport={new RelayTransport({ endpoint: '/api/feedback' })}
     appName="Acme"
     appVersion="1.0.0"
   />

Android (Kotlin)

1. Add the dependency (see Installation). The :android module bundles the shared core plus the Compose UI.

2. Build a client once at app start — androidFeedbackClient fills the device-info block from android.os.Build:

   import com.appfeedback.android.androidFeedbackClient
   import com.appfeedback.core.*
   
   val client = androidFeedbackClient(
     transport = GitHubDirectTransport(owner = "acme", repo = "feedback", token = token),
     appName = "Acme",
     appVersion = "1.0.0",
   )

3. Submit a report — submit returns the new issue number:

   val issueNumber = client.submit(
     FeedbackReport(type = FeedbackType.BUG, title = "Crash on launch", description = "Steps to reproduce…")
   )

4. Or drop in the themeable Compose sheet:

   import com.appfeedback.android.FeedbackSheet
   
   FeedbackSheet(client = client, onSubmitted = { number -> /* dismiss, toast… */ })

Where does the token live?

A GitHubDirectTransport token stays in the app’s secure storage — acceptable for a signed native app. To keep the token off the device, point a RelayTransport at a relay you control. See the security model.

What lands in GitHub

A labelled issue (bug/feature-request + user-submitted) whose body carries the description, a device-info block, optional contact email, and any attachments — in one byte-exact format across every platform.