Getting Started

ConvexCompose modules drop into any Convex app. The CLI is on the way; in the meantime, you can copy modules directly from the GitHub repo.

1. Prerequisites

• An existing Convex project (npx create-convex@latest)
• Node 20+ or Bun 1.x

2. Install a module

npx convexcompose install convex-mail

CLI coming soon. For now, copy the module folder from the GitHub repo into your Convex project's convex/ directory.

3. Wire it up

Each module ships with three layers — install the Convex backend first, then drop the React components into your frontend, then add the route wrapper for your router (TanStack Start, Next.js, Remix).

4. Compose more modules

Modules are designed to coexist. Install Mail and Tasks together — bug reports become issues, transactional emails come from your campaigns module, and everything stays reactive.