Skip to content

Danimaxpd/qrGenerator

Repository files navigation

QR Contact Generator

Project Overview

This project provides a simple and intuitive web application for generating QR codes for contact information. Users can easily create QR codes that can be scanned and added directly to contacts.

Features

  • Generate QR codes for contact information
  • Simple, user-friendly interface
  • Instant QR code creation
  • Downloadable QR code images

Technologies Used

  • Frontend: React
  • Deployment: Vercel
  • Database: UPSTASH REDIS

Requirements

Prerequisites

  • Node.js (v20 or later)
  • npm (v6 or later)
  • UPSTASH REDIS

Development Dependencies

  • React
  • TypeScript
  • ChakraUi
  • vercel/kv
  • qrcode

Getting Started

Installation

  1. Clone the repository
git clone https://github.com/your-username/qr-generator.git
  1. Install dependencies
npm install

Available Scripts

Development Mode

npm run dev

Runs the app in development mode. Open http://localhost:3000 to view it in the browser.

Production Build

npm run build
Builds the app for production to the `build` folder.

Deployment

The project is set up for easy deployment on Vercel:

  1. Push your code to a GitHub repository
  2. Connect the repository to Vercel
  3. Vercel will automatically deploy your application

Roadmap

v2 ???

  • Add more customization options for QR codes
  • Implement additional contact formats
  • Improve mobile responsiveness
  • Improve security

Support

If you encounter any issues or have questions, please open an issue on GitHub.

Invite me a cup of tea ☕

[PayPal Donation Link]

License

MIT License

Copyright (c) 2024 David Ricardo Jimenez Murcia

This project is licensed under the MIT License. See the LICENSE file for details.

Permissions:

  • Commercial use
  • Modification
  • Distribution
  • Private use

Limitations:

  • No Liability
  • No Warranty

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

About

A simple web application to generate Qrs.

Resources

License

Stars

Watchers

Forks

Packages

No packages published