This repository now contains only the Open Graph (OG) image generation service. Other endpoints were migrated to Go, this project focuses solely on generating PNG OG images used across sites and social previews.
- Exposes a single endpoint:
GET /ogwhich returns a generated PNG image (image/png). - Produces shareable, dynamic OG images using server-side rendering (Satori + Resvg).
Steps to run the project locally:
-
Clone the repository
git clone https://github.com/ccrsxx/og
-
Change directory to the project
cd api -
Install dependencies
npm install
-
Set up environment variables
Create a copy of the
.env.examplefile and name it.env.local. Fill in credentials as needed.copy .env.example .env.local
-
Run the app in development
npm run dev