OpenRoadmap Docs

Quickstart

Get a working feedback loop on any site in minutes: embed → submit → triage in the dashboard → publish on the portal.

1. Run OpenRoadmap locally

terminal · bash
pnpm install
pnpm --filter @openroadmap/widget build
pnpm dev
# optional demo host
pnpm demo

API + widget CDN: http://localhost:8787 · Dashboard: http://localhost:3000 · Portal: http://localhost:3001

2. Paste the embed

index.html · html
<script
  async
  src="http://localhost:8787/widget.js"
  data-project="pk_demo_acme_website"
  data-api="http://localhost:8787"
></script>
Tip

Prefer programmatic init? Call Feedback.init({ project, apiBase }) after the script loads — see JavaScript API.

3. Submit an idea

  1. Open your host page (or pnpm demo on :5173).
  2. Click the mascot → write a message → submit.
  3. Sign in to the dashboard with admin@acme.test.
  4. Inbox → Convert to feature → set status → check portal + email outbox.

4. Production checklist

  • Replace script src with your CDN host (e.g. https://cdn.openroadmap.app/widget.js).
  • Use your real project public key from Widget settings.
  • Allowlist your production domain in the project.
  • Set NEXT_PUBLIC_API_BASE on dashboard/portal builds.
  • Deploy with pnpm deploy — see Cloudflare.