Quick Start

Get started with SplitPay in 5 minutes by launching the decentralized web interface, connecting a Testnet wallet, and executing your first payment split on the Stellar Soroban Testnet.

Step 1: Check Prerequisites

Ensure you have Node.js v18.18+ (or v20+) and npm or pnpm installed. For interacting with the contract directly via CLI, you will also need the Stellar CLI.

Step 2: Clone & Run splitpay-web

# Clone the official web application repository
git clone https://github.com/Splitpayx/splitpay-web.git
cd splitpay-web
# Install dependencies
npm install
# Create local environment configuration
cp .env.example .env.local
# Start the Next.js development server
npm run dev

Visit http://localhost:3000 in your browser.

Step 3: Connect Wallet & Fund Testnet XLM

SplitPay offers two seamless ways to connect:

• Freighter Extension: Connect your Freighter wallet set to Test Net.
• Instant Dev Keypair: Generate a temporary Testnet keypair in one click directly inside the web app and click Fund via Friendbot to receive 10,000 free Testnet XLM.

Step 4: Create Your First Pool

1. Navigate to /pools/new.
2. Enter a unique integer Pool ID (e.g. 101).
3. Select the payment asset (e.g. Native XLM SAC: CDLZFC3SYJYDZT7K67VZ75HPJVIEUVNIXF47ZG2FB2RMQQVU2HHGCYSC).
4. Add member addresses and shares (e.g., Alice: 6000 BPS (60%), Bob: 4000 BPS (40%)).
5. Verify the total indicator displays 10,000 / 10,000 BPS.
6. Click Deploy Pool On-Chain and approve the transaction.

Step 5: Create & Settle a Payment

Once your pool is active, go to /payments/new:

1. Select Pool #101 and enter an amount (e.g. 100 XLM).
2. Inspect the live allocation preview: Alice will receive 60 XLM and Bob will receive 40 XLM.
3. Click Initiate Payment to record the pending payment on-chain.
4. Click Settle Payment to execute the atomic fund distribution.
5. Inspect the generated on-chain transaction hash on Stellar Expert Explorer.