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

og-image's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• chore(deps): update dependency @types/node to ^20.12.12

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update pnpm/action-setup action to v4

Detected dependencies

github-actions

.github/actions/prepare/action.yml

• pnpm/action-setup v3.0.0
• actions/setup-node v4.0.2

.github/workflows/build.yml

• actions/checkout v4.1.5

.github/workflows/deploy.yml

• actions/checkout v4.1.5
• pnpm/action-setup v3.0.0
• actions/setup-node v4.0.2

npm

package.json

• @vercel/og ^0.6.2
• next 14.2.3
• react ^18.3.1
• react-dom ^18.3.1
• slugify ^1.6.6
• @types/node ^20.12.11
• @types/react ^18.3.2
• @types/react-dom ^18.3.0
• autoprefixer ^10.4.19
• eslint ^9.2.0
• eslint-config-next 14.2.3
• postcss ^8.4.38
• tailwindcss ^3.4.3
• typescript ^5.4.5

---

• Check this box to trigger a request for Renovate to run again on this repository