Documentation | NeoOS MiniApps

Getting Started

Quick Start

Get your first MiniApp running in under 5 minutes

1. Install the SDK

The DevPack packages — @r3e-network/neo-miniapp-framework and @r3e-network/neo-miniapp-shared — are delivered through the reviewed tarball path. Current SDK releases are delivered as reviewed, checksummed .tgz tarballs in the DevPack repository under published-packages/sdk/<version>/. Install a release from its tarball files; external package registry publication is not part of the current delivery path:

bash

npm install ./r3e-network-neo-miniapp-framework-<version>.tgz ./r3e-network-neo-miniapp-shared-<version>.tgz

2. Create Your App

Start from a React/Vite entrypoint and register the app with the shared runtime. The canonical SDK guide contains the manifest and bundler setup:

bash

npm install\nnpm run dev

3. Initialize the SDK

Import and initialize the SDK in your app:

typescript

import { defineMiniApp } from '@r3e-network/neo-miniapp-shared/react';
import PlayArea from './PlayArea';
import manifest from './manifest';

defineMiniApp({
 appId: 'my-first-app',
 playArea: PlayArea,
 manifest,
 setup(ctx) {
   const app = ctx.framework;
   return { state: {} };
 },
});

4. Make Your First Transaction

typescript

// Contract writes go through the framework chain surface.
// This code runs inside the setup(ctx) callback from the previous example.
const app = ctx.framework;
const result = await app.chain.write({
 operation: 'yourContractMethod',
 args: [],
 successKey: 'transactionSubmitted',
});

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