Skip to content

connorakey/qr-code-generator

Repository files navigation

Connor's QR Code Generator

A simple, zero bloat, free and open source alternative to common QR Code Generators.

IconScreenShot1

Screenshots

Frontend Screenshot

Backend Screenshot 1

Backend Screenshot 2

API Reference

Generate QR Code

  GENERATE /generate?link=qrLink&size=pixels
Parameter Type Description
qrLink string Required. Link of QR Code to generator
pixels number Optional. Size of QR code (150 = 150x150)

Example

  localhost:3000/generate?link=youtube.com&size=70

Result:

ResultScreenshot1

Run Locally

Clone the project

  git clone https://github.com/connorakey/qr-code-generator

Go to the project directory

  cd qr-code-generator

Install dependencies

  npm install

Start the server

  node .

Run with Docker (by creating image)

Clone the project

    git clone https://github.com/connorakey/qr-code-generator

Go to project directory

    cd qr-code-generator

Build image

    docker build . -t qr-code-generator

Deploy image

    docker run -d -p 3000:3000 -p 3001:3001 --name qr-code-generator qr-code-generator

Ensure that the ports set in the docker run command are equal to the ports in the configuration.json file. The ports 3000 and 3001 ports are opened because of the backend and frontend websites.

FAQ

My users automatically get directed to localhost when the front end is used

To change the destination URL you must change the URL in configuration.json to your domain / ip

How do I change the ports of the front end and backend?

To change the ports enter the configuration.json and change the backend/front end ports to your desire, then enter backend.js and change the backend port.

Am I allowed to edit the code?

Yes, you are allowed to edit the code as much as you want, but no support will be given.

Am I allowed to reupload the code?

Yes, you are allowed to but please fork the original repository.

DISCLAIMER!!

I am not responsible for anything that goes wrong running this code, running it port forwarded may cause security issues and vulnerabilities.

Authors

Thank you

Thank you, Connor, 10th of November, 2024, Year 7

Docker support added by Connor 21st of April 2025, Year 8

About

Simple web based QR code generator without any bloat.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published