https://github.com/crossmint/onramp-quickstart
A ready-to-use template for building Web2/Web3 demos with Crossmint's Onramp.
https://github.com/crossmint/onramp-quickstart
Last synced: 8 months ago
JSON representation
A ready-to-use template for building Web2/Web3 demos with Crossmint's Onramp.
- Host: GitHub
- URL: https://github.com/crossmint/onramp-quickstart
- Owner: Crossmint
- Created: 2025-09-16T10:23:48.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-09-17T14:53:05.000Z (9 months ago)
- Last Synced: 2025-09-17T16:55:39.183Z (9 months ago)
- Language: TypeScript
- Homepage: https://crossmint-onramp-demo.vercel.app
- Size: 489 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Introduction
Create and fund a crypto wallet using Crossmint Onramp. This quickstart walks through creating an order, completing KYC (Persona) when required, collecting payment, and tracking delivery to the recipient wallet.
### Key features
- Accept fiat payments via credit and debit cards
- Create an onramp order
- Handle KYC via Persona when required
- Deliver funds directly to a buyer’s wallet
- Manage the full order lifecycle with real-time status updates
- Maintain full control over the UI and UX of your checkout flow
## Deploy
Easily deploy the template to Vercel with the button below. You will need to set the required environment variables in the Vercel dashboard.
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FCrossmint%2Fonramp-quickstart&env=CROSSMINT_SERVER_SIDE_API_KEY,CROSSMINT_ENV)
## Setup
1. Clone the repository and navigate to the project folder:
```bash
git clone https://github.com/crossmint/onramp-quickstart.git && cd onramp-quickstart
```
2. Install all dependencies:
```bash
npm install
# or
yarn install
# or
pnpm install
# or
bun install
```
3. Set up the environment variables:
```bash
cp .env.template .env
```
4. Get a Crossmint server API key from [here](https://docs.crossmint.com/introduction/platform/api-keys/server-side) and add it to the `.env` file. Ensure it has the scopes: `orders.read` and `orders.create`. The following variables are used by the API routes in this project:
```bash
CROSSMINT_SERVER_SIDE_API_KEY=your_server_api_key
# staging | production
CROSSMINT_ENV=staging
```
5. Run the development server:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
## Using in production
1. Create a [production server-side API key](https://docs.crossmint.com/introduction/platform/api-keys/server-side) key and set `CROSSMINT_ENV=production`.