Skip to content

ccrsxx/og

Repository files navigation

OG

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.

What it does

  • Exposes a single endpoint: GET /og which returns a generated PNG image (image/png).
  • Produces shareable, dynamic OG images using server-side rendering (Satori + Resvg).

Development

Steps to run the project locally:

  1. Clone the repository

    git clone https://github.com/ccrsxx/og
  2. Change directory to the project

    cd api
  3. Install dependencies

    npm install
  4. Set up environment variables

    Create a copy of the .env.example file and name it .env.local. Fill in credentials as needed.

    copy .env.example .env.local
  5. Run the app in development

    npm run dev