Partner quickstart

Clone your host app repo

Clone the repo Appbrew shared with you: either a copy of the Appbrew sample app, or a dedicated app provisioned for your product (with your own store, this app can even ship to the stores as your product's showcase). Either way it arrives ready. The .env points at a store (the shared demo store, or yours), so the app runs against real config immediately. No repo yet? See Getting access.

Install and run

With the toolchain installed:

mise install
pnpm install
pnpm run-ios      # or pnpm run-android

See Run your app for what the dev server does and common first-run issues.

Scaffold your integration package

pnpm create-integration <name>

This creates packages/<name>/ with a package.json and a src/index.ts to export from. The folder is a pnpm workspace member, and the host app consumes it as a workspace:* dependency, so edits to your package source hot-reload in the running app. Run pnpm install once after scaffolding.

Build your blocks and trackers

Develop in packages/<name>/src/. Start with the Build section: custom blocks for UI that renders on screens, analytics trackers for event forwarding, and the integration model for how it all fits together.

Test in the app

Import your package by name in the host app (wire blocks into src/app/register-blocks.ts, setup code into src/app/App.tsx) and exercise it on the simulator against the demo store's config. See Testing.

Publish your package

When it works end to end, publish it under your npm scope so merchant apps can install it. See Publishing packages.

Appbrew enables it for merchants

Tell your Appbrew contact the package is ready. Appbrew enables the integration for merchant apps, and the settings you declared in your manifest appear in the merchant dashboard for merchants to configure.