Install Orwel in React and Vite | Orwel
2 minutes orwel@1
Open in Claude

Install Orwel in React and Vite

  1. Install the package

    With yarn or pnpm use their equivalent.

    terminal
    npm i orwel@latest
  2. Add your production API key

    Signed out you see a placeholder. Sign in and your real key shows up here.

    .env
    VITE_ORWEL_KEY=orwel_pk_TU_KEY
  3. Init once on the client

    Call it once when the app boots, before any event.

    src/main.tsx
    import { orwel } from 'orwel'
    
    orwel.init({ apiKey: import.meta.env.VITE_ORWEL_KEY })
  4. Capture your leads

    On submit of every form that captures a contact: identify the person and await the conversion before redirecting. If r.success is false, r.reason tells you why.

    contact form
    import { orwel } from 'orwel'
    
    async function onSubmit(data) {
      orwel.identify({ email: data.email, name: data.name })
      const r = await orwel.conversion('contact_form')
      if (!r.success) console.warn('Orwel:', r.reason)
    }
  5. Verify it live

    Use the dev key instead of the production one while you test. Those events are flagged as test and never count in your reports.

    Open your site with the dev key and watch every event arrive in Dev mode Open Dev mode

No key yet?

Create your workspace and this guide fills in your keys.

Sign up