Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

QR Code Generator

Tired of using platforms to create QR codes and sign up? There's now a solution. This QR Code generator helps you make QR Codes for any site.

A modern, production-ready QR Code generator CLI built with TypeScript and Node.js. Generate QR codes from any text or URL directly from your terminal.

Features

  • Generate QR codes from any text or URL
  • Outputs high-quality PNG files
  • Clean CLI interface with helpful error messages
  • Written entirely in TypeScript with strict type checking
  • ESLint and Prettier for code quality
  • Lightweight with minimal dependencies

Cloning the Repository

git clone https://github.com/vortexsinclair/qrcode_gen

Installation

npm

npm install

pnpm

pnpm install

Usage

Generate a QR Code

npm run generate https://example.com

or

pnpm run generate https://example.com

Examples

npm run generate https://openai.com
pnpm run generate https://github.com
npm run generate "Hello World"

Example Output

✔ QR code generated successfully!
Saved to qrcode_example.com.png

Generated QR codes are saved in the project root with a name derived from the input:

Command Output File
npm run generate https://example.com qrcode_example.com.png
npm run generate https://github.com qrcode_github.com.png
npm run generate "Hello World" qrcode_Hello_World.png

Development

Build

npm run build

Lint

npm run lint

Format

npm run format

Tech Stack

  • Language: TypeScript
  • Runtime: Node.js
  • QR Library: qrcode
  • Linting: ESLint with TypeScript plugin
  • Formatting: Prettier
  • Package Manager: npm / pnpm

License

MIT License. See LICENSE for details.

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/my-feature)
  3. Commit your changes (git commit -m "Add my feature")
  4. Push to the branch (git push origin feature/my-feature)
  5. Open a Pull Request

Credits

  • qrcode — QR code generation library

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages