sanwebinfo / og-image

Simple API to Generate the OG image for website and blogs.

Vercel OG

Simple API to Generate the OG image for website and blogs.

Features

• Next.JS
• Vercel Edge Functions
• Typescript
• Next API Routes
• @vercel/og Module for Generate og image

Modification

• API: /src/app/api/og/route.jsx Modify the og image generation according to your needs.

How to use?

http://localhost:3000/api/og?title=sanweb

Installation 📦

• Required node.js LTS version (18 or 20)
• pnpm package manager

npm install -g pnpm

• Clone this repo or Download

git clone https://github.com/sanwebinfo/og-image
cd og-image
pnpm install

• Test the site

pnpm dev

• Build a site

pnpm build

• Test the Production build

pnpm start

Free Deploy

Reference

• Open Graph (OG) Image Generation - https://vercel.com/docs/functions/edge-functions/og-image-generation
• Guide to Create OG API using Next.js and vercel - https://blog.dennisokeeffe.com/blog/2022-10-15-using-the-new-vercel-opengraph-image-generation

LICENSE

MIT