World Developer Docs

MiniKit-JS is our official SDK for creating mini apps that work with World App.

Quick Start

The fastest way to get started is by using our template next-15 repository. Run the following command and follow the instructions to create a new mini app. This installs dependencies with npm; to use pnpm, add --no-install and run pnpm install in the new directory.

npx @worldcoin/create-mini-app@latest my-first-mini-app

Correctly running template should look like this

Manual Installation

MiniKit-JS is the core library and is framework agnostic. Install it with pnpm, or use a CDN like jsdelivr for inline HTML. Replace [version] with the release you want to load.

pnpm install @worldcoin/minikit-js

<script type="module">
  import { MiniKit } from "https://cdn.jsdelivr.net/npm/@worldcoin/minikit-js@[version]/+esm";
</script>

TypeScript: the package’s type declarations reference window.WorldApp without declaring it, so type-checking fails with "skipLibCheck": false. Set "skipLibCheck": true in tsconfig.json (the Next.js default), or add the Window.WorldApp declaration.

Usage

Wrap your app with MiniKitProvider in a client component. This initializes MiniKit and makes it available throughout your app.

src/app/providers.tsx

"use client";

import { MiniKitProvider } from "@worldcoin/minikit-js/minikit-provider";

export default function Providers({
  children,
}: {
  children: React.ReactNode;
}) {
  return <MiniKitProvider>{children}</MiniKitProvider>;
}

src/app/layout.tsx

import Providers from "./providers";

export default function RootLayout({
  children,
}: {
  children: React.ReactNode;
}) {
  return (
    <html lang="en">
      <body>
        <Providers>{children}</Providers>
      </body>
    </html>
  );
}

Check if MiniKit is installed. MiniKit.isInstalled() will only return true if the mini app is opened and initialized inside the World App. This is useful to distinguish between a user opening your app in the browser or in the World App.

import { MiniKit } from "@worldcoin/minikit-js";

console.log(MiniKit.isInstalled());

In a React component, you can read this reactively with the useMiniKit() hook, as the official starter template does:

import { useMiniKit } from "@worldcoin/minikit-js/minikit-provider";

export function MiniKitStatus() {
  const { isInstalled } = useMiniKit();

  if (!isInstalled) return null;

  return <span>MiniKit is installed</span>;
}

Build with AI

The World Docs MCP lets any coding assistant search the World documentation to help you build your mini app.

Claude Code
Codex
Cursor
VS Code

claude mcp add --transport http --scope project world-docs https://docs.world.org/mcp

--scope project writes a shareable .mcp.json to your project (recommended). Without it, the server is added only for you in this project (stored in ~/.claude.json); use --scope user to add it to all your projects.

codex mcp add world-docs --url https://docs.world.org/mcp

Add to .cursor/mcp.json:

{
  "mcpServers": {
    "world-docs": {
      "url": "https://docs.world.org/mcp"
    }
  }
}

Add to .vscode/mcp.json:

{
  "servers": {
    "world-docs": {
      "type": "http",
      "url": "https://docs.world.org/mcp"
    }
  }
}

Template Repositories

The following template repositories are also available:

Otherwise, continue below with the installation instructions.

Watch a video tutorial here.

Introduction

Integrate

Commands

Technical Reference

Migration

Further Reading

Getting Started

Quick Start

Manual Installation

Usage

Build with AI

Template Repositories

​Quick Start

​Manual Installation

​Usage

​Build with AI

​Template Repositories

Quick Start

Manual Installation

Usage

Build with AI

Template Repositories