zyrielzero/qr-code-generator-app repository overview

⁠QR Code Generator

A small command-line tool that encodes a URL into a QR code image. Output location and colors are configurable through environment variables, and the app is packaged as a Docker image for reproducible runs anywhere.

⁠Features

• Generates a QR code PNG from any valid URL
• Validates the URL before encoding and rejects malformed input
• Configurable output directory and colors via environment variables
• Timestamped filenames so repeated runs never overwrite each other
• Logs each run to both the console and a log file
• Containerized with Docker and published to DockerHub

⁠Requirements

• Python 3.12 (or run it through Docker, no local Python needed)
• Dependencies listed in requirements.txt

⁠Local Setup

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

⁠Usage

Run with the default URL:

python main.py

Encode a specific URL:

python main.py --url https://www.njit.edu

The QR code is saved to the qr_codes/ directory by default.

⁠Configuration

The following environment variables override the defaults:

Note: keep the fill color dark and the background light. Scanners read dark modules on a light background, so inverting them produces a code that will not scan.

⁠Running with Docker

Build the image:

docker build -t qr-code-generator-app .

Run it (writes the QR code to a mounted host folder):

docker run --rm -v "$(pwd)/qr_codes:/app/qr_codes" qr-code-generator-app --url https://www.njit.edu

⁠Pull from DockerHub

The image is published at zyrielzero/qr-code-generator-app⁠:

docker pull zyrielzero/qr-code-generator-app:latest
docker run --rm zyrielzero/qr-code-generator-app

⁠Continuous Integration

A GitHub Actions workflow (.github/workflows/docker-image.yml) builds the image and pushes it to DockerHub automatically on every push to main.