Beginner

Installation

Install and configure VibeReview in 2 minutes

Install the package

1npm install @vibereview/react

Add the Provider

In your app/layout.tsx (Next.js) or App.tsx (React) file:

1import { VibeReviewProvider } from '@vibereview/react';
2
3export default function Layout({ children }) {
4  return (
5    <VibeReviewProvider 
6      projectId="proj_abc123"
7      apiKey="vbr_xyz789"
8    >
9      {children}
10    </VibeReviewProvider>
11  );
12}

💡

Tip: Where to find your keys? Go to your Dashboard → Select your project → Settings → API Keys

Create your first trigger

Before using VibeReview in your code, create a trigger in the Dashboard:

Go to Dashboard → Your Project
Click on "Create a trigger"
Give it a name (e.g., "Export PDF") and an identifier (e.g., "export-pdf")
Configure your question and options

ℹ️

What's a trigger? A trigger represents a specific action or feature in your app (like "Export PDF", "Send Email", "Generate Report", etc.). Each trigger has its own feedback question and appears right after the user completes that action.

✅

That's it! You can now use this trigger in your code.

🤖

For AI Agents

Copy this prompt to help your AI agent integrate VibeReview into your project.