Documentation | Neo MiniApp Platform

Getting Started

Quick Start

Get your first MiniApp running in under 5 minutes

1. Install the SDK

Install the Neo MiniApp SDK using npm or yarn:

bash

npm install @neo-miniapp/sdk

2. Create Your App

Use our CLI to scaffold a new MiniApp project:

bash

npx create-miniapp my-first-app\ncd my-first-app\nnpm run dev

3. Initialize the SDK

Import and initialize the SDK in your app:

typescript

import { MiniApp } from '@neo-miniapp/sdk';

const app = new MiniApp({
  appId: 'my-first-app',
  network: 'testnet', // or 'mainnet'
});

// Connect to wallet
const account = await app.wallet.connect();
console.log('Connected:', account.address);

4. Make Your First Transaction

typescript

// Transfer GAS
const result = await app.wallet.transfer({
  to: 'NXxx...recipient',
  asset: 'GAS',
  amount: '1.5',
});

console.log('TX Hash:', result.txid);