Docs · SDK · Remix

Install Brevwick in Remix.

Copy-paste the snippets below. Replace pk_test_demo with the public key from your project — find it under Project settings → Keys.

1. Install

Install the adapter alongside the core SDK.

npm install @tatlacas/brevwick-react @tatlacas/brevwick-sdk modern-screenshot

2. Configure env vars

Wire the project key through your framework’s env convention so it gets inlined into the client bundle at build time.

# Public project key. Surface to the client via Remix `loader` / `useRouteLoaderData` — never read process.env in client code.
BREVWICK_PROJECT_KEY=pk_test_demo

3. Wire the SDK

app/root.tsxTSX

import { Links, Meta, Outlet, Scripts, ScrollRestoration } from '@remix-run/react';
import { BrevwickProvider, FeedbackButton } from '@tatlacas/brevwick-react';

const config = { projectKey: 'pk_test_demo' };

export default function App() {
  return (
    <html lang="en">
      <head>
        <Meta />
        <Links />
      </head>
      <body>
        <BrevwickProvider config={config}>
          <Outlet />
          <FeedbackButton position="bottom-right" />
        </BrevwickProvider>
        <ScrollRestoration />
        <Scripts />
      </body>
    </html>
  );
}

Verify

  • Run `remix dev` and open the app.
  • Click the floating feedback button.
  • Submit a test issue.
  • Confirm the issue lands in /app/issues.

Full guide: /docs/sdk/remix

Published packages

Browse the registry for version history, source, and download counts.