Getting Started
Installation
Install the packages you need and bootstrap the local playground.
Installation
Install only the packages that match your flow. The auth plugins, runtime adapter, and simulator can live side by side, but they do not depend on each other.
Direct sign-in
pnpm add better-auth @onmax/better-auth-nimiq-pay
Add @nimiq/core only when you want to use the optional createNimiqCoreSignatureVerifier() helper.
pnpm add @nimiq/core
QR desktop handoff
pnpm add better-auth @onmax/better-auth-mobile-qr @onmax/mobile-signer-bridge @onmax/mobile-signer-nimiq-pay
Mini-app runtime adapter
pnpm add @onmax/nimiq-mini-app-runtime
Local simulator
pnpm add -D @onmax/nimiq-mini-app-simulator
Shared E2E utilities
pnpm add -D @onmax/better-auth-nimiq-pay-e2e
Verify the local workspace
bash
pnpm install
pnpm playground:dev
pnpm docs:dev
Expected result:
- the playground runs both demos from one Nuxt app
- the docs site starts locally so you can review the package and guide pages together
Playground routes:
/direct/nimiq-pay/qr/desktop/qr/phone/[challengeId]/qr/result