Skip to content

Latest commit

 

History

History
145 lines (101 loc) · 5.26 KB

README.md

File metadata and controls

145 lines (101 loc) · 5.26 KB

OGCOPS

CI License: MIT PRs Welcome

Free, open-source OG image generator. 109 templates, 8 platform previews, free API. No login, no watermarks.

Live: og.codercops.com

OGCOPS

Why OGCOPS?

Most OG image generators require sign-up, add watermarks, impose rate limits, or lock templates behind paywalls.

OGCOPS is different:

  • Completely free — no login, no watermarks, no rate limits
  • Open source — MIT licensed, self-hostable, fully transparent
  • 109 templates — professional designs across 12 categories, ready to use
  • Instant preview — client-side Satori rendering, zero server calls while editing
  • Developer-friendly API — generate images via URL, CORS-enabled, no API key needed

Features

  • 109 Templates across 12 categories: Blog, Product, SaaS, GitHub, Event, Podcast, Developer, Newsletter, Quote, E-commerce, Job, Tutorial
  • 8 Platform Previews: Twitter/X, Facebook, LinkedIn, Discord, Slack, Reddit, WhatsApp, Google Search — see exactly how your image looks on each platform
  • Free REST API: Generate OG images via URL. CORS-enabled. No API key required.
  • Social Preview Checker: Paste any URL to analyze its meta tags and see platform previews
  • Client-side Rendering: Satori runs in the browser for instant preview during editing. Zero server calls while editing.
  • URL-based State: All editor state is encoded in URL params — share or bookmark any configuration

Quick Start

git clone -b dev https://github.com/codercops/ogcops.git
cd ogcops
npm install
npm run dev

Visit http://localhost:4321 to start generating OG images.

API

Generate an OG image:

GET https://og.codercops.com/api/og?title=Hello+World&template=blog-minimal-dark

Returns a 1200x630 PNG image. Pass any template field as a query parameter.

Check a URL's meta tags:

GET https://og.codercops.com/api/preview?url=https://example.com

List all templates:

GET https://og.codercops.com/api/templates

See API documentation for full details, parameters, and response formats.

Self-Hosting

OGCOPS requires no environment variables for basic usage. Deploy it anywhere that runs Node.js.

Deploy to Vercel (Recommended)

Deploy with Vercel

Manual Deployment

git clone https://github.com/codercops/ogcops.git
cd ogcops
npm install
npm run build

The build output in dist/ can be deployed to any Node.js hosting platform.

Template Categories

Category Count Description
Blog 12 Blog posts, articles, editorial content
Product 10 Product announcements and launches
SaaS 10 SaaS products and landing pages
GitHub 10 Open source and GitHub projects
Event 10 Events, conferences, meetups
Podcast 8 Podcasts, videos, audio content
Developer 9 Developer profiles and portfolios
Newsletter 8 Newsletter issues and digests
Quote 8 Quotes and social media posts
E-commerce 8 Products, sales, commerce
Job 8 Job listings and hiring
Tutorial 8 Tutorials, courses, education

Tech Stack

Contributing

Contributions are welcome — templates, bug fixes, features, docs, and more. See CONTRIBUTING.md for setup and guidelines.

Important: Always fork and branch from dev (the default branch). The production branch is for releases only. PRs targeting production directly will be closed.

# Fork the repo on GitHub, then:
git clone https://github.com/<your-username>/ogcops.git
cd ogcops
git checkout dev
git checkout -b your-feature-branch

License

MIT

Contributors

Acknowledgments

  • Satori by Vercel — SVG generation from JSX
  • resvg-wasm — SVG to PNG conversion
  • Astro — web framework
  • React — UI components