Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sanwebinfo/og-image
Simple API to Generate the OG image for website and blogs.
https://github.com/sanwebinfo/og-image
api next nextjs13 og-image og-image-generator typescript vercel vercel-og
Last synced: about 1 month ago
JSON representation
Simple API to Generate the OG image for website and blogs.
- Host: GitHub
- URL: https://github.com/sanwebinfo/og-image
- Owner: sanwebinfo
- License: mit
- Created: 2023-12-13T11:00:13.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-29T18:21:58.000Z (2 months ago)
- Last Synced: 2024-10-29T20:28:05.505Z (2 months ago)
- Topics: api, next, nextjs13, og-image, og-image-generator, typescript, vercel, vercel-og
- Language: TypeScript
- Homepage:
- Size: 416 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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?
```sh
http://localhost:3000/api/og?title=sanweb
```
## Installation 📦
- Required node.js LTS version (18 or 20)
- `pnpm` package manager
```sh
npm install -g pnpm
```
- Clone this repo or Download
```sh
git clone https://github.com/sanwebinfo/og-image
cd og-image
pnpm install
```
- Test the site
```sh
pnpm dev
```
- Build a site
```sh
pnpm build
```
- Test the Production build
```sh
pnpm start
```
## Free Deploy
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fsanwebinfo%2Fog-image)
## Reference
- Open Graph (OG) Image Generation -
- Guide to Create OG API using Next.js and vercel -
## LICENSE
MIT