@poap-xyz/frames

@poap-xyz/frames

@poap-xyz/frames is a package to help with the development of Farcaster Frames.

Features

• Generate the frame meta tags
• Generate the frame HTML markup

Installation

NPM

npm install @poap-xyz/frames

Yarn

yarn add @poap-xyz/frames

Usage

Meta tags

const frame = useMemo(() => new Frame({ ... });
return (
  <>
    <NextSeo
      title="Hello World"
      description="..."
      openGraph={{ images: [...] }}
      additionalMetaTags={frame.toMetaTags()}
    />
    <div>...</div>
  </>
)

HTML render

// /api/frame.ts
export default async function handler(req: NextApiRequest, res: NextApiResponse) {
  const frame = new Frame({ ... });
  return res.status(200).send(frame.render());
}

Examples

For example scripts and usage, please check the examples.

Contributing

We welcome contributions! Please see the CONTRIBUTING.md file for guidelines.

License

@poap-xyz/frames is released under the MIT License.