Quick Start

Get your local ChainPay development environment up and running in under five minutes.

Prerequisites

Ensure you have the following installed on your machine:

  • Node.js (version 18 or higher)
  • pnpm (version 9.0.0 or higher)
  • Docker Desktop (for running the PostgreSQL container)

Step 1: Installation & Seeding

Clone the repository, download dependencies, spin up the Postgres database, and run migrations and seed scripts:

# 1. Clone the repository and install dependencies
pnpm install

# 2. Start PostgreSQL container in the background
docker compose up -d

# 3. Seed your database and setup mock tables
pnpm --filter api db:push
pnpm --filter api run db:seed

Step 2: Start Development Servers

Launch the frontend and backend servers together under Turborepo, then start the blockchain watcher client:

# Start the developer environment (Dashboard, Landing Page, Docs Portal)
pnpm dev

# In a separate terminal, launch the blockchain watcher service
pnpm watcher
⚠️ Run a local Ethereum node (Anvil)

For local payment verification testing, run a local foundry Anvil node:anvil --block-time 1. This simulates EVM block mining every second so you can test payment confirmation intervals in real time.

Step 3: Access Console

Verify that your services are running correctly at these local addresses: