RoastNest

Introduction

Roastnest collects feedback with the context already attached — the element the user pointed at, a screenshot, and the page they were on.

Most feedback arrives as a sentence with no scene around it. Somebody writes “the button is broken” and a developer spends twenty minutes reconstructing which button, on which page, in which state. Roastnest closes that gap by capturing the context at the moment the feedback is written.

The SDK, @roastnest/react, drops into any React app and gives your users a floating trigger. From there they can highlight a DOM element, let the widget screenshot it, and write what went wrong. The same package also ships a referral widget and conversion-tracking APIs.

Terminal
npm install @roastnest/react

How it fits together

Roastnest has three moving parts, and you rarely need all three at once.

  • The React SDK — @roastnest/react renders the feedback and referral widgets inside your app and handles element selection, screenshots and submission.
  • The dashboard — where feedback lands, gets triaged, assigned a status and priority, and syncs out to Jira, Slack or Discord.
  • The public API — read-only REST endpoints for pulling a project's public feedback into your own changelog or status page.

Two modes

Every widget runs in one of two modes, set once on the provider. This is the first decision to make, because it determines which props are required and where the data goes.

  • Cloud — submissions go to Roastnest, and the widget pulls its configuration and theme from your dashboard. You pass a projectId and nothing else.
  • Self-hosted — nothing leaves your infrastructure. You supply an onFormSubmit handler for feedback and an onEvent handler for referrals, and store the payloads wherever you like.

Modes covers the trade-off in detail, including which props each mode forbids at compile time.

In a hurry?

The quickstart gets a working feedback widget onto a page in four steps.

Where to go next

QuickstartInstall, wrap your app, drop in the widget, collect your first report.InstallationPackage setup, provider placement and the CSP rule you will need.Feedback widgetElement selection, screenshots, and controlling the widget yourself.Referral widgetInvite cards, auto-generated referral links and share actions.ThemingTen CSS variables that restyle both widgets at once.API referencePublic REST endpoints for reading project feedback.

Open source

The SDK is MIT licensed and developed in the open at RoastNestHQ/react-widget. Issues and pull requests are welcome, and the self-hosted mode exists so you can run the whole feedback loop without sending us anything.