Skip to content

Turn your link into a QrCode using my website. πŸ‘¨β€πŸ’»

Notifications You must be signed in to change notification settings

brendondev/qr.Code

Repository files navigation

qr.Code πŸ‘¨β€πŸ’»

image

This project is a QR Code generator using React, Vite, TypeScript and TailwindCSS, with integration of the QR Code generation API.

πŸ“ #Description

This is a simple web application that allows the user to generate QR Codes from text or URLs and adjust the size of the generated QR Code. It uses the QR Code Generation API to create the QR image based on user input.


πŸ›  Technologies Used

  • React: JavaScript library for building user interfaces.
  • Vite: Rapid development tool for modern frontend applications.
  • TypeScript: Superset of JavaScript with optional static typing.
  • TailwindCSS: Utility CSS framework for styling.
  • TanStack React Query: Asynchronous state management and data caching.

βš™οΈ Requirements

Before you start, you will need to have installed:

  • Node.js: v14+ or higher
  • npm or yarn

πŸš€ Installation and Execution

  1. Clone this repository:
  1. Navigate to the project directory:

cd QR-Code-Generator

  1. Install the dependencies:

npm install

  1. Run the project:

npm run dev

  1. Access the project in the browser:

http://localhost:5173


🌐 QR Code API

The API used to generate QR Codes in this project is the APGY QR Code API.

Endpoint

GET https://api.apgy.in/qr/?data={data}&size={size}

Parameters

  • data (String): The data to be encoded in the QR Code. Example: https://mysite.com.
  • size (Number): The size of the QR Code in pixels. Example: 300.

✏️ Customization

Changing the QR Code Size To change the size of the generated QR Code, the default value is 300, but you can adjust it by modifying the logic in the QRCodeGenerator.tsx component:

const [size, setSize] = useState<number>(300);


🀝 Contributions

Contributions are always welcome! If you want to contribute improvements to the project, follow these steps:

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

πŸ“ License

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