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

Package detail

@worldcoin/minikit-react

andy_tfh8.3kMIT1.9.7TypeScript support: included

minikit-react is a set of hooks for building mini-apps

minikit, miniapps

readme

minikit-react

This package contains helper functions and components for building mini apps with React. This is not required to run a mini app and is only a convenience package for developers as it contains nice abstractions.

🚀 Getting Started

MiniKit is currently available on npm. To install, run:

pnpm i @worldcoin/minikit-react

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.