create-farcaster-mini-app/README.md

Frames v2 Quickstart by Neynar 🪐

A Farcaster Frames v2 quickstart npx script.

This is a NextJS + TypeScript + React app.

Getting Started

To create a new frames project, run:

npx create-neynar-farcaster-frame@latest

To run the project:

cd <PROJECT_NAME>
npm run dev

Importing the CLI

To invoke the CLI directly in JavaScript, add the npm package to your project and use the following import statement:

import { init } from 'create-neynar-farcaster-frame';

Deploying to Vercel

For projects that have made minimal changes to the quickstart template, deploy to vercel by running:

npm run deploy:vercel

Building for Production

To create a production build, run:

npm run build

The above command will generate a .env file based on the .env.local file and user input. Be sure to configure those environment variables on your hosting platform.