Thanks to visit codestin.com
Credit goes to github.com

Skip to content

quran/next-open-graph

Repository files navigation

Quran.com Open Graph Image Generator

Tech Stack

How to use

  1. Main Image

Quran.com

https://og.qurancdn.com/api/og

Optional query parameters:

  • lang - Image locale. Defaults to en.

  1. Chapter Image

Quran.com

https://og.qurancdn.com/api/og/chapter/[chapterId]

Required parameters:

  • [chapterId] - Chapter number from 1-114.

Optional query parameters:

  • lang - Image locale. Defaults to en.
  • verse - Verse number.

  1. About the Quran Image

Quran.com

https://og.qurancdn.com/api/og/about-the-quran


  1. Learning Plans Image

Quran.com

https://og.qurancdn.com/api/og/learning-plans

  1. Media Generator Image

Quran.com

https://og.qurancdn.com/api/og/media

  1. Preparing for Ramadan

Quran.com

https://og.qurancdn.com/api/og/preparing-for-ramadan

  1. What Is Ramadan Image

Quran.com

https://og.qurancdn.com/api/og/what-is-ramadan

  1. Explore Answers

Quran.com

https://og.qurancdn.com/api/og/explore-answers

  1. Calendar

Quran.com

https://og.qurancdn.com/api/og/calendar

  1. Beyond Ramadan

Quran.com

https://og.qurancdn.com/api/og/beyond-ramadan

Optional query parameters:

  • lang - Image locale. Defaults to en.

Testing

This project uses Playwright for automated testing, including visual regression tests for OG images.

Prerequisites

# Use Node.js 24
nvm use 24

# Install dependencies
yarn install

# Install Playwright browsers
npx playwright install chromium

Running Tests

# Run all tests (starts dev server automatically)
yarn test

# Run tests in interactive UI mode
yarn test:ui

# Update visual regression snapshots
yarn test:update-snapshots

Testing Against Production

BASE_URL=https://og.qurancdn.com yarn test

Test Coverage

  • OG Image Generation: Validates that all endpoints return valid PNG images
  • Visual Regression: Compares generated images against baseline snapshots for all 12 supported languages (ar, bn, en, es, fa, fr, id, ms, nl, sw, tr, ur)

About

Quran.com Open Graph Image Generator

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •