OnchainKit

React components and TypeScript utilities to help you build top-tier onchain apps.

🚀 Quickstart

Run npm create onchain to bootstrap an example onchain app with all the batteries included.

For documentation and guides, visit onchainkit.xyz.

This project is set up as a monorepo with pnpm workspaces.

git clone https://github.com/coinbase/onchainkit.git

pnpm install

To run a script in a single package, use the following command:

pnpm [-F | --filter] <package-name> <script-name>

To run a script in all packages, use the following command:

pnpm run <script-name>

We provide shorthands to filter by project in the root package.json.

The following shorthands are available:

When working on components, you can build OnchainKit in watch mode and start the playground to view your components with the following command:

pnpm f:play dev:watch

Then, you can view the playground at http://localhost:3000.

This project is licensed under the MIT License - see the LICENSE.md file for details