Skip to content

Latest commit

 

History

History
150 lines (110 loc) · 5.38 KB

README.md

File metadata and controls

150 lines (110 loc) · 5.38 KB

Quick QR

A lightweight and easy-to-use web-based QR Code Generator that enables users to create and download QR codes instantly. This project is part of the Android Club: Your Open Source AcWoC'25! initiative at VIT Bhopal.

🚀 Features

  • Generate QR codes for text, URLs, or any input data.
  • Customize the size of the QR code.
  • Download the generated QR code as an image file (PNG, JPG, SVG, PDF).
  • Embed logos inside QR codes.
  • Batch QR code generation through file upload.
  • Color customization (foreground and background).
  • Provide error correction levels (L, M, Q, H).
  • User authentication with Google.
  • Manage and share QR codes.
  • Dark mode support.
  • Responsive design for mobile and desktop.

Future Enhancements

  • Add support for colour customization (foreground and background).
  • Provide error correction levels (L, M, Q, H).
  • Bulk QR code generation through file upload.
  • Embed logos inside QR codes.
  • Dynamic QR codes that can be updated with new data.
  • Mobile app version of the QR code generator.

💻 Technologies Used

  • HTML5: Structure and layout.
  • CSS3: Styling and responsiveness.
  • JavaScript: QR code generation logic.
  • Firebase: User authentication and Firestore database.
  • JSZip: Batch QR code download as a ZIP file.
  • QRCode.js: QR code generation library.
  • jsPDF: PDF generation library.

📂 Project Structure

QR-Code-Generator
├── index.html          # Main HTML file for the app
├── style.css           # CSS for styling the app
├── script.js           # JavaScript for QR code generation
├── share.html          # HTML for sharing QR codes
├── share.js            # JavaScript for sharing QR codes
├── batch.html          # HTML for batch QR code generation
├── batch.js            # JavaScript for batch QR code generation
├── batch.css           # CSS for batch QR code generation
├── instruction.html    # HTML for instructions on how to use the app
├── README.md           # Documentation
├── Contribution Guideline # Contribution guidelines
├── Code_Of_Conduct.md  # Code of conduct
├── .github/            # GitHub configuration files
│   ├── ISSUE_TEMPLATE/ # Issue templates
│   ├── PULL_REQUEST_TEMPLATE/ # Pull request template
│   └── workflows/      # GitHub Actions workflows
└── images/             # Images used in the project

🤝 Contributing

Contributions are welcome and greatly appreciated! To get started:

Guidelines

  1. Fork the Repository: Click on the "Fork" button at the top right corner of the repository page.

  2. Clone the Forked Repository: Run the following command in your terminal:

    git clone https://github.com/your-username/QR-Code-Generator.git

  3. Create a Branch: Use a descriptive name for your branch, such as add-feature or fix-bug:

    git checkout -b your-branch-name

  4. Make Your Changes: Implement your changes or additions. Ensure that your code adheres to the coding standards and is well-documented.

  5. Test Your Changes: Test the application to ensure that your modifications work as expected.

  6. Commit Your Changes: Write a clear and concise commit message:

     git checkout -b your-branch-name

  7. Push to Your Fork: Push your changes to the forked repository:

    git checkout -b your-branch-name

  8. Open a Pull Request (PR): Go to the original repository and open a pull request. Provide a detailed description of your changes and why they should be merged.

Code of Conduct

  • Be respectful and inclusive towards others.
  • Provide clear documentation for any features or fixes you introduce.
  • Adhere to the repository's coding standards and best practices.

Issues

  • Search Before Raising: Check if the issue already exists to avoid duplicates.
  • Provide Details: Clearly describe the problem and include steps to reproduce it, if applicable.
  • Be Constructive: Avoid vague or unhelpful comments on issues.

Testing

  • Test Your Code: Ensure that your changes are well-tested before submission.
  • No Breaking Changes: Make sure your contribution doesn’t break existing functionality.

📜 License

This project is licensed under the MIT License. You are free to use, modify, and distribute this project as long as you include the original license.

🌟 Acknowledgments

  • Android Club: For organizing AcWoC'25 and fostering open source contributions.
  • Contributors: A big thank you to everyone who has contributed to this project!
  • Project by Notion Community, VIT Bhopal

Contributors ✨

Thanks to these amazing people for their contributions! 🚀

💖 Thank you for your valuable contributions!