Skip to content

QR Codes on the edge! A straightforward solution for generating QR codes to be used in websites, emails, and more.

License

Notifications You must be signed in to change notification settings

jmcmullen/qr-kit

Repository files navigation

QR Kit

This template enables the creation of QR codes at the edge for quick response times and low latency. It can be easily integrated into various digital platforms like websites and emails.

Deploy your own

This project is an ideal starting point for anyone seeking a quick, ready-to-use solution for incorporating QR codes into their Next.js project.

Deploy with Vercel

Usage

GET request, all parameters are read from the URL query.

Here's a sample request:

https://qr-kit.vercel.app/api?value=https://github.com/jmcmullen/qr-kit&size=200&ecLevel=H&logoImage=https://qr-kit.vercel.app/sash.svg&logoHeight=80&logoWidth=80

Result:

Options

Here are the query parameters you can specify to the API endpoint:

Query Parameter Type Range/Values Default Required
value string - - Yes
size number 0 - 100,000 600 No
ecLevel string 'L', 'M', 'Q', 'H' 'M' No
quietZone number 0 - 100,000 1 No
bgColor string Hex color '#fff' No
fgColor string Hex color '#000' No
logoImage string Image URL null No
logoWidth number 0 - 100,000 300 No
logoHeight number 0 - 100,000 300 No
logoOpacity number 0 - 100 100 No
logoRemoveBg boolean true, false false No

About

QR Codes on the edge! A straightforward solution for generating QR codes to be used in websites, emails, and more.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published