README.md

create-fframe-app

This is an interactive CLI to start a farcaster frames server application using Next.js and TypeScript.

Load this example frame using warpcast's frame validator: https://create-fframe-app.vercel.app/api/example

getting started

make sure you have Node.js and npx installed, then run:

npx create-fframe-app
# or
npx create-fframe-app@latest

to add a new frame applet, run this from your project root:

npm run generate-applet my-applet
# or
yarn generate-applet my-applet

local testing

start the development server locally:

npm run dev
# or
yarn dev

then:

• click here to test image generation
• click here to test the API response

server testing

to test a live server deployment:

• deploy your fframe app on vercel
• add NEXT_PUBLIC_FFRAME_BASE_URL=https://{your-project-name}.vercel.app as an environment variable and redeploy the project
• test using warpcast's frame validator (paste https://{your-project-name}.vercel.app/api/{your_applet_id})