dolfindevelopers
GET STARTED

Getting started

The SDK includes hooks and connected components. Start with working finance experiences, or use its hooks with your own markup. UI components are the pure presentation layer: your application supplies their values, state and callbacks. Use either layer independently or combine them.

Choose SDK or UI

Both component layers are editable source installed through the same private shadcn registry. The SDK's hooks and server helpers are an npm package.

Use them together or independently. SDK connected components combine Dolfin hooks with the same pure UI. Supply UI props from your own controller, or use SDK hooks with your own markup. Only SDK hooks and connected components need DolfinProvider.
  1. Your appYour routes, layout and design system
  2. Connected SDK components@dolfin/* via the shadcn registry. Source lives in your repo.
    Standalone UI or your own markupYour controller supplies props and callbacks; SDK hooks are optional.
  3. @dolfinai/reactnpm package. DolfinProvider, hooks, caching, permissions
  4. Your serverIssues a short-lived Dolfin token for the signed-in user
  5. Dolfin APIBills, invoices, expenses, approvals, payments

From an empty app to your first component

  1. Prepare your React app and initialise shadcn/ui.
  2. Configure the private registry once for both SDK and UI components.
  3. Follow the connected SDK example to add a Bills table and connect Dolfin, or the standalone UI example to render a card with your own props.

Only need data access with your own markup? Start with SDK hooks. You can skip shadcn/ui and the registry entirely.

Quick decision

If youUse
Want a bills, invoices or expenses screen working todaySDK connected components
Want Dolfin UI with application-owned state and data flowStandalone UI components
Have your own design system and want full control of markupSDK hooks
Do not use shadcn/ui, or cannot get a registry token yetSDK hooks
Want a ready-made table but a custom detail viewBoth, side by side

SDK hooks and connected components use DolfinProviderand your server authentication route. Standalone UI takes explicit props and requires no SDK provider. Your application can still supply Dolfin data through SDK hooks or GraphQL.

NEXT: SHARED COMPONENT SETUP

Set up the registry