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. For cleanliness we recommend usingpnpm
as your package manager.

Correctly running template should look like this
Manual Installation
MiniKit-JS is the core lib, framework agnostic, MiniKit-React provides hooks that make it easy to interact with the MiniKit SDK.Usage
- Wrap your root with the MiniKitProvider component.This provides the MiniKit object to your app.
src/index.tsx
- Check if MiniKit is installed and ready to use
MiniKit.isInstalled()
will only return true if the app is opened and properly initialized inside the World App. This is useful to distinguish between a user opening your app in the browser or in the World App.
Build with AI
We have generated a llms-full.txt file that converts all our documentation into a single markdown document following the https://llmstxt.org/ standard.Template Repositories
The following template repositories are also available:- Vanilla JS (using a CDN) template (featuring a simple backend for verifications),
- Community example - Wallet Auth using JWT.
- Community example - Wallet Auth using NextAuth.
Watch a video tutorial here.