If looking to convert an existing web app into a mini app, see here.

This tutorial shows how to create a Farcaster mini app (prev. called frames) with one simple command in less than 60s.

Simply type npx @neynar/create-farcaster-mini-app@latest in any terminal window

  • package is open source (github )
  • using neynar services is optional
  • demo API key is included if you haven’t subscribed yet

The flow:

  • generates signature required by frame spec on your behalf and puts in the farcaster manifest
  • sets up splash image, CTA, etc. as part of workflow (incl. personalized share images, more on that below)
  • spins up a localtunnel hosted url so you can debug immediately, no need to ngrok or cloudflare on your own
  • if you use neynar:
    • automatically fetches user data
    • automatically sets sets up notifications and analytics(just put in your client id from the dev portal)

See < 1 min video here that goes from scratch to testable frame:

If you have questions or feature requests, please reach out to @veganbeef or @rish. We are always looking forward to working with developers!

​
Appendix

A great way to make your mini app go viral is to give your users personalized share images / urls that they can share on their social media timelines. Our starter kit makes it easy. Simply add /share/[fid] at the end of your mini app domain to create a personalized share image for that user e.g. [your_url].[extension]/share/[fid] should create an embed image like below: