Skip to content

stephen-lakes/qrcode-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

QR Code Generation API

Description

The QR Code Generation API is a powerful and flexible solution for generating QR codes from text input. Built with TypeScript and Node.js, this API supports various output formats, including base64-encoded images, image files, streams, and embedded HTML. Comprehensive error handling ensures a smooth user experience, while Swagger documentation provides an easy-to-use interface for developers.

Features

  • QR Code Generation: Generate QR codes from user-provided text.
  • Multiple Output Formats: Support for base64-encoded images, downloadable image files, and streams.
  • HTML Response: Option to return an HTML page with the embedded QR code image.
  • Error Handling: Comprehensive error handling to ensure a seamless user experience and provide clear, informative error messages.
  • Swagger Documentation: Easy-to-use API documentation available at /api-docs.

Technologies Used

  • TypeScript: For enhanced type safety and better developer experience.
  • Node.js: For building the server-side application.
  • Express.js: For managing routing and middleware.
  • QRCode: For generating QR codes.
  • Swagger: For documenting the API endpoints.
  • Nodemon: For automatically restarting the server during development.

Getting Started

Prerequisites

  • Node.js
  • npm (Node Package Manager)
  • TypeScript

Installation

  1. Clone the repository:

    git clone https://github.com/stephen-lakes/qrcode-api.git
    
  2. Change directory:

    cd qr-code-api
    
  3. Install depencencies:

    npm Install
    
  4. Run the application

    npm run dev
    

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published