framecaster
v0.9.5
Published
<p align="center"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/Zizzamia/a-frame-in-100-lines/blob/main/public/park-4.png"> <img alt="OnchainKit logo vibes" src="https://github.com/Zizzamia/a-frame-in-100-lin
Downloads
3
Readme
A Frame in 100 lines (or less)
Farcaster Frames in less than 100 lines, and ready to be deployed to Vercel.
To test a deployed Frame, use: https://warpcast.com/~/developers/frames.
To test a localhost Frame, use: Framegear. A simple tool that allows you to run and test your frames locally:
- without publishing
- without casting
- without spending warps
And let us know what you build by either mentioning @zizzamia on Warpcast or X.
Have fun! ⛵️
App Routing files
- app/
- api/
- frame/
app/page.tsx
import { getFrameMetadata } from '@coinbase/onchainkit/frame';
import type { Metadata } from 'next';
import { NEXT_PUBLIC_URL } from './config';
const frameMetadata = getFrameMetadata({
buttons: [
{
label: 'Story time!',
},
{
action: 'link',
label: 'Link to Google',
target: 'https://www.google.com',
},
{
label: 'Redirect to pictures',
action: 'post_redirect',
},
],
image: {
src: `${NEXT_PUBLIC_URL}/park-3.png`,
aspectRatio: '1:1',
},
input: {
text: 'Tell me a boat story',
},
postUrl: `${NEXT_PUBLIC_URL}/api/frame`,
});
export const metadata: Metadata = {
title: 'FRAMECASTER',
description: 'LFG',
openGraph: {
title: 'FRAMECASTER',
description: 'LFG',
images: [`${NEXT_PUBLIC_URL}/park-1.png`],
},
other: {
...frameMetadata,
},
};
export default function Page() {
return (
<>
<h1>FRAMECASTER</h1>
</>
);
}
app/layout.tsx
export const viewport = {
width: 'device-width',
initialScale: 1.0,
};
export default function RootLayout({ children }: { children: React.ReactNode }) {
return (
<html lang="en">
<body>{children}</body>
</html>
);
}
app/config.ts
export const NEXT_PUBLIC_URL = 'FRAMECASTER';
app/api/frame/route.ts
import { FrameRequest, getFrameMessage, getFrameHtmlResponse } from '@coinbase/onchainkit/frame';
import { NextRequest, NextResponse } from 'next/server';
import { NEXT_PUBLIC_URL } from '../../config';
async function getResponse(req: NextRequest): Promise<NextResponse> {
let accountAddress: string | undefined = '';
let text: string | undefined = '';
const body: FrameRequest = await req.json();
const { isValid, message } = await getFrameMessage(body, { neynarApiKey: 'NEYNAR_ONCHAIN_KIT' });
if (isValid) {
accountAddress = message.interactor.verified_accounts[0];
}
if (message?.input) {
text = message.input;
}
if (message?.button === 3) {
return NextResponse.redirect(
'https://www.google.com/search?q=cute+dog+pictures&tbm=isch&source=lnms',
{ status: 302 },
);
}
return new NextResponse(
getFrameHtmlResponse({
buttons: [
{
label: `🌲 ${text} 🌲`,
},
],
image: {
src: `${NEXT_PUBLIC_URL}/park-1.png`,
},
postUrl: `${NEXT_PUBLIC_URL}/api/frame`,
}),
);
}
export async function POST(req: NextRequest): Promise<Response> {
return getResponse(req);
}
export const dynamic = 'force-dynamic';
Resources
- Official Farcaster Frames documentation
- Official Farcaster Frame specification
- OnchainKit documentation
Community ☁️ 🌁 ☁️
Check out the following places for more OnchainKit-related content:
- Follow @zizzamia (X, Farcaster) for project updates
- Join the discussions on our OnchainKit warpcast channel
Authors
License
This project is licensed under the MIT License - see the LICENSE.md file for details