Skip to main content

​
What is a Mini App?

A mini app is a lightweight web app that runs directly inside Farcaster clients like Base App, without needing to open a browser or download anything. Built using familiar tools like Next.js and MiniKit, mini apps behave just like normal apps — but launch instantly from posts, making them feel native to the social experience. This guide gets you from zero to a running Mini App using the MiniKit template.
These docs are LLM‑friendly for AI development tools. Copy individual pages as markdown from the dropdown menu above, or reference the complete docs at llms.txt for comprehensive Mini App knowledge in your AI assistant.

​
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

Terminal
npx create-onchain --mini
You’ll be prompted for a CDP Client API key. You can generate one in the Coinbase Developer Platform.
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 a live URL used when creating your manifest.