Install

Scaffold a new MiniKit project, install dependencies, and run it locally

This guide gets you from zero to a running Mini App using the MiniKit template.

Prerequisites

1. Farcaster account (for testing and manifest signing)
2. Optional: Coinbase Developer Platform account for a Client API key

Create your project

1. Use the CLI to scaffold a Mini App

   npx create-onchain --mini
   

   You’ll be prompted for a CDP Client API key. You can generate one in the Coinbase Developer Platform.

   These docs are LLM‑friendly—reference llms.txt in your editor to streamline builds and prompts: https://docs.base.org/base-app/build-with-minikit/llms.txt

2. Skip manifest setup for now

   You’ll configure the manifest after you have a stable URL in the Deploy step.

3. Install dependencies and run locally

   Terminal

   cd your-project-name
   npm install
   npm run dev
   

Next: Deploy your app to get a live URL for testing in Farcaster.

Deploy and test

Deploy with Vercel (recommended) or use ngrok for local tunneling