Skip to main content

Project Setup

Overview

Projects are created through the Volr CLI. Run the setup wizard to create a project, connect your wallet, and configure accepted tokens — all in one command.

Setup

1. Run the CLI

npx create-volr

The wizard will guide you through:

  • Authentication — Sign in with your email (OTP verification)
  • Wallet — Connect your receiver wallet via browser
  • Project — Create a new checkout project (or select existing)
  • Tokens — Choose which stablecoins to accept (USDC, USDT, etc.)

2. Verify your setup

volr checkout doctor

After Setup

Your project is now configured with:

  • volr.json — Project configuration (commit this)
  • .env with VOLR_SERVER_KEY — Your server API key (don't commit this)

Managing Your Project

Use volr checkout setup to update:

  • Webhook URL
  • Success/cancel redirect URLs
  • Accepted tokens

The Volr Dashboard is available for monitoring payments and managing project settings.

Next Steps