Skip to content

README.md

Latest commit

 

History

History
101 lines (62 loc) · 1.73 KB

README.md

File metadata and controls

101 lines (62 loc) · 1.73 KB
Raw

QR Code Generator API

A flexible backend API for generating QR codes in various formats, including text, URL, vCard, MeCard, WiFi, email, SMS, telephone, geo location, calendar events, Bitcoin, and UPI.

Features

  • Generate QR codes for multiple data types
  • Supports both GET (query params) and POST (JSON body) requests
  • Customizable foreground and background colors
  • Built with Express, TypeScript, and QRCode

Supported QR Formats

  • Text/URL
  • vCard
  • MeCard
  • WiFi
  • Email
  • SMS
  • Telephone
  • Geo Location
  • Calendar Event
  • Bitcoin
  • UPI

See FORMATS.md for detailed format examples.

API Endpoints

GET /api/create/:type

Generate a QR code using query parameters.

Example:

GET /api/create/vcard?firstName=John&lastName=Doe&email=john@example.com

POST /api/create/:type

Generate a QR code using a JSON body.

Example:

POST /api/create/wifi Content-Type: application/json
{ "type": "WPA", "ssid": "MyNetwork", "password": "mypassword" }

Color Customization

Add fg and bg parameters (hex color codes) to customize QR code colors.

Example:

GET /api/create/text_url?text_url=Hello&fg=%23000000&bg=%23ffffff

Examples

See examples

Getting Started

Prerequisites

  • Node.js (v18+ recommended)
  • npm

Installation

for docker setup go to feature/docker branch

# Dependency Installation
npm install

# Development
npm run dev

#Build
npm run build

# Start (Production)
npm start

Configuration

Environment variables can be set in a .env file:

PORT=<PORT>
REDIS_URL=redis://localhost:6379

Author:

Ravish Ranjan