https://github.com/helios2003/ogp-studio

Service to generate dynamic Open Graph images for shared studio document.
https://github.com/helios2003/ogp-studio

Last synced: 7 days ago
JSON representation

Service to generate dynamic Open Graph images for shared studio document.

• Host: GitHub
• URL: https://github.com/helios2003/ogp-studio
• Owner: helios2003
• Created: 2024-06-18T04:26:04.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-08-19T17:15:39.000Z (4 months ago)
• Last Synced: 2024-08-20T19:56:56.704Z (4 months ago)
• Language: TypeScript
• Homepage: https://ogp-studio.netlify.app
• Size: 147 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Ogp-Studio 

This repository hosts the code which helps in creating dynamic Open Graph image for the shared document of [AsyncAPI Studio](https://github.com/asyncapi/studio).

## Installation

- Clone the repository.

- Run `npm install`.

- Run ``npm run dev`` to start the server. It runs on ``http://locallhost:3000``.

## Usage

- The project is hosted on Vercel Edge which uses Edge runtime. You can read more about it [here](https://vercel.com/docs/functions/runtimes/edge-runtime).

**Example Usage**: View the Open Graph image at https://ogp-studio.vercel.app/api/og?title=Account%20Service&description=This%20service%20is%20in%20charge%20of%20processing%20user%20signups&numServers=0&numChannels=1