Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@worldcoin/minikit-js

andy_tfh18.4kMIT1.9.6TypeScript support: included

minikit-js is our SDK for building mini-apps.

minikit, miniapps

readme

minikit-js

🚀 Getting Started

MiniKit is currently available on npm. To install, run: pnpm i @worldcoin/minikit-js

or use the CDN: https://cdn.jsdelivr.net/npm/@worldcoin/minikit-js@[version]/+esm

For comprehensive setup instructions and usage examples, visit our developer documentation.

🛠 ️Developing Locally

To run the example mini app locally:

pnpm i
cd demo/with-next
pnpm dev

This will launch a demo mini app with all essential commands implemented, allowing you to explore and test the features.

📦 Installation

To quick start with a template, run: npx @worldcoin/create-mini-app my-first-mini-app

This will create a new directory called my-first-mini-app with a basic template setup.

Take a look at the in the template for more information.