Merchant quickstart
Clone your app repo, install, and run it on a simulator.
Appbrew provisions a dedicated app repo for your store and hands you access. The repo arrives ready to run: dependencies are pinned and the .env already points at your store's app config. Access to Appbrew's shared libraries (@gauntlet/*, @app-brew/* on npm.appbrew.tech) is configured in the repo's .npmrc with a read-only token, so pnpm install works with no per-machine registry setup. If it returns a 401, see Registry access.
No repo yet?
There is no self-serve or from-scratch path — see Getting access: install the Appbrew app on your store, share the domain and GitHub usernames, and your repo gets provisioned.
1. Clone your repo
Clone the repo Appbrew shared with you:
git clone git@github.com:<your-org>/<your-app>.git
cd <your-app>2. Install the toolchain and dependencies
Install mise first if you haven't, then:
mise install # pinned Node, pnpm, Ruby, JDK (run `mise trust` if prompted)
pnpm installIf pnpm install returns a 401 from npm.appbrew.tech, the committed registry token has been rotated — see Registry access and ask Appbrew for a fresh one.
3. Run the app
pnpm run-iosInstalls pods, builds, and launches on a simulator.
You should see your store's app boot with its real home screen, navigation, and products, all rendered from the app config served by the Appbrew backend. Run your app explains what the dev server does, how hot reload works, and the common first-run failures.
Where next
Build a custom block
Write a React Native block, register it, and place it on a screen from the Appbrew dashboard.
Set up milo
Wire Appbrew's CLI into your coding agent to work with app config and place blocks.
Your app repo
How the repo is laid out, what you own versus what Appbrew updates, and how releases work.