Base Mini App Quickstart

This is a Mini App template built using OnchainKit and the Farcaster SDK. It is designed to help you build and deploy a Mini App that can be published to the Base App and Farcaster.

Important

This is a workshop template. Please follow the instructions below to configure and deploy your app.

Prerequisites

Before getting started, make sure you have:

• A Farcaster account (for testing)
• A Vercel account for deployment
• A Coinbase Developer Platform Onchainkit Client API Key
• Basic knowledge of Base Build platform

Getting Started

1. Fork & Clone & Install

• Fork this repository
• After forking, clone your forked template project

git clone https://github.com/[your_username]/[your_forked_repository_name].git
cd [your_forked_repository_name]
npm install

2. Configure Environment

Create a .env file based on .example.env:

NEXT_PUBLIC_ONCHAINKIT_API_KEY=<YOUR-CDP-API-KEY>
NEXT_PUBLIC_URL=http://localhost:3000

3. Run Locally

npm run dev

Open http://localhost:3000 to see your app.

Customization

Minikit Configuration

The minikit.config.ts file configures your app's manifest.

1. Open minikit.config.ts.
2. Update name, subtitle, and description to match your app idea.
3. Note: Skip the accountAssociation for now; we will add this after deployment. IMPORTANT: Follow manifest documentation for configuring your app's manifest

Note: You can update manifest metadata of your app after deployment if you don't have an idea yet.

Deployment

1. Deploy to Vercel

vercel --prod

or

Use the Vercel website and add your repository as a new project.

2. Update Production Env

In your Vercel project settings, add:

• NEXT_PUBLIC_ONCHAINKIT_API_KEY
• NEXT_PUBLIC_URL (Your Vercel deployment URL)

Base Build & Publishing

To publish your app to the Base App ecosystem:

1. Go to Base Build and log in.
2. Click Mini App Tools button at top right of the website.
3. Paste your deployed website link provided by Vercel into the field.
4. Use the Account Association tools on Base Build to sign your manifest.
5. Update minikit.config.ts with the signature and redeploy.

For detailed docs, visit docs.base.org.

---

Disclaimer

This project is a demo application for educational purposes only.