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.
✨ 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
- Clone the repository
git clone https://github.com/coinbase/onchainkit.git
- 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/onchainkitpnpm f:play:pnpm --filter playgroundpnpm f:create:pnpm --filter create-onchainpnpm 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
- OnchainKit (X, Warpcast)
- Tina He (X)
- Mind Apivessa (X)
- Alissa Crane (X)
- Alec Chen (X)
- Paul Cramer (X)
- Shelley Lai (X, Warpcast)
- Léo Galley (X)
- Adam Lessey (X)
💫 Contributors
🌊 License
This project is licensed under the MIT License - see the LICENSE.md file for details