This is a demo Mini App application built using OnchainKit and the Farcaster SDK. Build a waitlist sign-up mini app for your company that can be published to the Base app and Farcaster.

Before getting started, make sure you have:

• Base app account
• A Farcaster account
• Vercel account for hosting the application
• Coinbase Developer Platform Client API Key

git clone https://github.com/base/demos.git

cd demos/minikit/waitlist-mini-app-qs
npm install

Create a .env.local file and add your environment variables:

NEXT_PUBLIC_PROJECT_NAME="Your App Name"
NEXT_PUBLIC_ONCHAINKIT_API_KEY=<Replace-WITH-YOUR-CDP-API-KEY>
NEXT_PUBLIC_URL=

npm run dev

The minikit.config.ts file configures your manifest located at app/.well-known/farcaster.json.

Skip the accountAssociation object for now.

To personalize your app, change the name, subtitle, and description fields and add images to your /public folder. Then update their URLs in the file.

vercel --prod

You should have a URL deployed to a domain similar to: https://your-vercel-project-name.vercel.app/

Add your production URL to your local .env file:

NEXT_PUBLIC_PROJECT_NAME="Your App Name"
NEXT_PUBLIC_ONCHAINKIT_API_KEY=<Replace-WITH-YOUR-CDP-API-KEY>
NEXT_PUBLIC_URL=https://your-vercel-project-name.vercel.app/

Add environment variables to your production environment:

vercel env add NEXT_PUBLIC_PROJECT_NAME production
vercel env add NEXT_PUBLIC_ONCHAINKIT_API_KEY production
vercel env add NEXT_PUBLIC_URL production

1. Navigate to Farcaster Manifest tool
2. Paste your domain in the form field (ex: your-vercel-project-name.vercel.app)
3. Click the Generate account association button and follow the on-screen instructions for signing with your Farcaster wallet
4. Copy the accountAssociation object

Update your minikit.config.ts file to include the accountAssociation object:

export const minikitConfig = {
    accountAssociation: {
        "header": "your-header-here",
        "payload": "your-payload-here",
        "signature": "your-signature-here"
    },
    frame: {
        // ... rest of your frame configuration
    },
}

vercel --prod

Go to base.dev/preview to validate your app:

1. Add your app URL to view the embeds and click the launch button to verify the app launches as expected
2. Use the "Account association" tab to verify the association credentials were created correctly
3. Use the "Metadata" tab to see the metadata added from the manifest and identify any missing fields

To publish your app, create a post in the Base app with your app's URL.

For detailed step-by-step instructions, see the Create a Mini App tutorial in the Base documentation.