Command-line tool for scaffolding complete Next.js XRPL wallet applications.

🚀 Quick Start

# Clone the repository
git clone https://github.com/zhaben/xrp-genie.git
cd xrp-genie

# Install dependencies
npm install

# Create your app
npx xrp-genie init my-app
cd my-app
npm run dev

📋 What It Creates

The CLI generates a complete Next.js application with:

  • XRPL wallet integration (Web3Auth, Xaman, or Faucet)
  • Tailwind CSS styling
  • TypeScript support
  • Working examples of wallet connection and transactions
  • Environment configuration files

🎯 Choose Your Integration

During initialization, you’ll select:

🔐 Web3Auth (Social Login)

  • Google, Twitter, Discord login
  • No wallet installation required
  • Perfect for mainstream users
  • Requires Web3Auth setup

📱 Xaman (Mobile Wallet)

  • QR code signing flow
  • Mobile wallet integration
  • Secure transaction signing
  • Requires Xaman setup

🧪 Faucet (Development)

  • Direct wallet creation
  • Automatic testnet funding
  • Perfect for development/testing
  • No external setup required

🌐 Network Selection

Choose between:

  • Testnet - For development and testing
  • Mainnet - For production applications

📁 Project Structure

Generated project includes:

my-app/
├── app/
│   ├── globals.css
│   ├── layout.tsx
│   └── page.tsx
├── hooks/
│   └── useXrplWallet.ts     # Wallet integration
├── package.json
├── tailwind.config.js
├── tsconfig.json
└── .env.local.example       # Environment variables

⚡ Commands

Initialize Project

npx xrp-genie init <project-name>

Development

cd <project-name>
npm run dev

Build

npm run build

Start Production

npm start

🔧 Configuration

After initialization:

  1. Copy environment file: 
    cp .env.local.example .env.local
  2. Add your API keys (for Web3Auth/Xaman):
  3. Start development: 
    npm run dev

📚 Next Steps

After creating your app:

🔗 Alternative: Use the SDK

For existing projects, use the XRP Genie SDK instead:

npm install xrp-genie-sdk xrpl