https://github.com/rabbitholegg/create-fframe-app
an interactive CLI to quickstart a farcaster frames server application
https://github.com/rabbitholegg/create-fframe-app
farcaster farcaster-frames next nextjs server typescript
Last synced: 11 days ago
JSON representation
an interactive CLI to quickstart a farcaster frames server application
- Host: GitHub
- URL: https://github.com/rabbitholegg/create-fframe-app
- Owner: rabbitholegg
- License: mit
- Created: 2024-02-06T15:43:16.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-06T18:35:32.000Z (about 2 years ago)
- Last Synced: 2025-02-02T05:44:40.980Z (about 1 year ago)
- Topics: farcaster, farcaster-frames, next, nextjs, server, typescript
- Language: JavaScript
- Homepage: https://create-fframe-app.vercel.app
- Size: 52.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# create-fframe-app
This is an interactive CLI to start a [farcaster frames](https://docs.farcaster.xyz/learn/what-is-farcaster/frames) server application using Next.js and TypeScript.
Load this example frame using [warpcast's frame validator](https://warpcast.com/~/developers/frames):
`https://create-fframe-app.vercel.app/api/example`
## getting started
make sure you have Node.js and npx installed, then run:
```bash
npx create-fframe-app
# or
npx create-fframe-app@latest
```
to add a new frame applet, run this from your project root:
```bash
npm run generate-applet my-applet
# or
yarn generate-applet my-applet
```
## local testing
start the development server locally:
```bash
npm run dev
# or
yarn dev
```
then:
* [click here](http://127.0.0.1:3000/api/example/images?frameId=1) to test image generation
* [click here](http://127.0.0.1:3000/api/example?frameId=0) to test the API response
## server testing
to test a live server deployment:
* deploy your _fframe_ app on [vercel](https://vercel.com)
* 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](https://warpcast.com/~/developers/frames) (paste `https://{your-project-name}.vercel.app/api/{your_applet_id}`)