Skip to content

Aamir-Rafique/QRcodegenerator-react

Repository files navigation

QR Code Generator

License

A blazing fast React application powered by Vite and modern development practices. Perfect for rapid development, prototyping, and deployment.


📝 Table of Contents

  1. QR Code Generator
  2. Overview
  3. Prerequisites
  4. Installation
  5. Running the Application
  6. Project Structure
  7. Available Scripts
  8. Deployment
  9. Technologies Used
  10. Contributing
  11. License

📖 Overview

This project is a React + Vite-based web application designed to save your url, username and password in your browsers localStorage.
It emphasizes performance, fast refresh, minimal configuration, and ease of use.

Key Features:

  • Lightning-fast development with Vite
  • React with hooks and functional components

✅ Prerequisites

Ensure you have the following installed:

Check versions:

node -v
npm -v
git --version

📦 Installation

Clone the repository and install dependencies:

git clone https://github.com/Aamir-Rafique/ar-QRcodegenerator-react.git
cd ar-QRcodegenerator-react
npm install 
# or
yarn install

# then
npm i react-toastify
npm i react-qr-code

🚀 Running the Application

Start the development server:

npm run dev
# or
yarn dev

Then open http://localhost:5173 to view it in the browser.


📁 Project Structure

QRcodegenerator-react/
├── public
│   |── icons/
│   └── images/
├── src/
│   ├── assets/
│   ├── components/
│   │   ├── QRCodeGen.jsx
│   │   └── Footer.jsx
│   ├── App.jsx
│   ├── main.jsx
│   └── index.css
├── .gitignore
├── index.html
├── package-lock.json
├── package.json
├── README.md
├── LICENSE
├── vite.config.js


⚙️ Available Scripts

Script Description
npm run dev Runs app in development mode

🚢 Deployment

You can deploy this app using:

  • Vercel
  • Netlify
  • GitHub Pages
  • Any static host (upload the dist/ folder after npm run build)

Example (Vercel):

  1. Push your repo to GitHub
  2. Link it in your Vercel dashboard
  3. Set npm run build as the build command
  4. Set dist as the output directory

🛠 Technologies Used


🤝 Contributing

Contributions are welcome! Here's how to get started:

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/your-feature)
  3. Make your changes and commit them
  4. Push to your fork (git push origin feature/your-feature)
  5. Open a pull request

Please follow the Conventional Commits standard for commits.


📄 License

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


📷 Screenshots

App Screenshot


🙋‍♂️ Questions?

If you have any questions or suggestions, feel free to open an issue or reach out on Gmail, LinkedIn, GitHub.


Made with ❤️ by Aamir-Rafique

About

This Repo contains a simple React based, QR code generator application built using React, TailwindCSS and react-qrcode library

Topics

Resources

License

Stars

Watchers

Forks