Integration Examples Contributor
Project-specific standards and workflows for the Dwolla integration examples repo.
Quick Reference
These rules take precedence over all other instructions.
- •Keep new work consistent with existing packages (structure, naming, env usage)
- •Do not add real API keys or secrets; keep them in env files
- •Follow each package README for required env vars and provider-specific steps
- •Reuse shared utilities in
src/utilswhere available
Repo Layout
- •Root uses shared tooling (ESLint/Prettier/TS configs); run
pnpm installat the repo root before working in any package - •Packages by goal:
- •Open Banking:
packages/open-banking/plaid,packages/open-banking/mx - •Secure Token Exchange:
packages/secure-token-exchange/plaid|mx|mastercard|flinks - •Push to Card (card funding source + payout):
packages/push-to-card/checkout
- •Open Banking:
Build and Run Basics
- •Copy
.env.local.example→.env.localin the target package and fill provider/Dwolla creds - •From repo root, install deps:
pnpm install - •From the package directory, run
pnpm dev - •Follow package README for provider-specific steps (e.g., Mastercard SDK generation)
How to Assist
- •Stay aligned with each package’s README for env vars and setup
- •Mirror patterns already present in similar integrations
- •Keep sample code minimal, focused on illustrating Dwolla and third party integration flows
- •Add succinct comments only when code is non-obvious
Guardrails
- •Never commit real API keys, secrets, or PII data
- •Keep sensitive values in environment files, not in code or logs
- •Use sandbox/test credentials in examples and docs
Product-Specific Notes
- •Checkout.com Flow sample requires Dwolla Push to Card access and Checkout.com keys; env vars include
CKO_PUBLIC_KEY,CKO_SECRET_KEY,CKO_ENV,CKO_PROCESSING_CHANNEL_ID - •Mastercard secure exchange sample: run
scripts/generate_mastercard_sdk.sh(requirespnpm) beforepnpm dev