Skip to content

For usage within NodeJS, an npm package which allows for the creation of a QR code with an embedded logo. Easily place logo within the center of a QR code using Node JS.

License

Notifications You must be signed in to change notification settings

mrsanjaya/qr-with-logo

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

qr-with-logo is a Node package developed to allow for the creation of QR codes with embedded logo images.

Installation

Use node package manager (npm) to install install QRLogo.

npm install --save qr-with-logo

Saving as PNG

const QRLogo = require('qr-with-logo');

const data = JSON.stringify({name: "Zacharie Happel",
              job:  "Student/Intern", 
              grade: "Senior"
})
 
await QRLogo.generateQRWithLogo(data, "logo.png", {}, "PNG", "qrlogo.png") 

Base64

const QRLogo = require('qr-with-logo');

const data = JSON.stringify({name: "Zacharie Happel",
              job:  "Student/Intern", 
              grade: "Senior"
})
 
await QRLogo.generateQRWithLogo(data, "logo.png", {}, "Base64", "qrlogo.png", async function(b64) {
              console.log("Base64: \n" + b64);
}); 

Information

QRLogo currently only supports saving images as PNG and the exportation of Base64 formatted data.

qrcode to facilitate the creation of the QR codes, and the sharp npm package as the means to which images are overlaid.

qrcode options may be included when creating the QR code image:

const opts = {
   errorCorrectionLevel:'H',
   rendererOpts: { quality: 0.3 }
}; 

Example Input/Output:

Logo Image:

Logo

QR Code:

QR

License

MIT

About

For usage within NodeJS, an npm package which allows for the creation of a QR code with an embedded logo. Easily place logo within the center of a QR code using Node JS.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%