OnchainKit

React components and TypeScript utilities to help you build top-tier onchain apps.
GitHub
795
Created a year ago, last commit 18 hours ago
90 contributors
1.79k commits
Stars added on GitHub, month by month
N/A
N/A
N/A
N/A
4
5
6
7
8
9
10
11
12
1
2
3
2024
2025
Stars added on GitHub, per day, on average
Yesterday
+1
Last week
+1.0
/day
Last month
+1.1
/day
npmPackage on NPM
Monthly downloads on NPM
4
5
6
7
8
9
10
11
12
1
2
3
2024
2025
README

OnchainKit logo vibes

OnchainKit

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

Version last update Downloads per month Code coverage MIT License

Follow @OnchainKit Chat on Discord stars forks


🚀 Quickstart

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

✨ Documentation

For documentation and guides, visit onchainkit.xyz.

🛠️ Contributing

Overview

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

Requirements

  • Node.js v18
  • pnpm v10

Getting Started

  1. Clone the repository
git clone https://github.com/coinbase/onchainkit.git
  1. Install dependencies
pnpm install

Running packages

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>

Shorthands

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

The following shorthands are available:

  • pnpm f:ock: pnpm --filter @coinbase/onchainkit
  • pnpm f:play: pnpm --filter playground
  • pnpm f:create: pnpm --filter create-onchain
  • pnpm f:manifest: pnpm --filter miniapp-manifest-generator

Development

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.

🌁 Team and Community

💫 Contributors

🌊 License

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