Warning
This repository is a work in progress! Don't fork or clone until the repo is marked as active.
A simple QR Code Generator web application built with React and TypeScript. This project allows users to generate QR codes for various inputs like URLs, text, phone numbers, and more.
- Input Options: Generate QR codes for URLs, text, email addresses, and phone numbers.
- Customization: Control QR code size, margin, and color.
- Download: Download generated QR codes as PNG images.
- React: Frontend library for building user interfaces.
- TypeScript: Adds static typing to JavaScript to improve developer productivity and code quality.
- qrcode.react: React component for generating QR codes.
- styled-components: CSS-in-JS library for styling React components.
To run this project locally, clone the repository and navigate into the project directory, use npm or yarn to install the necessary dependencies and run the vite development server:
git clone https://github.com/PegasusXing/react-vite-qrcode.git
cd react-vite-qrcode
npm install
npm run dev
# or
yarn install
yarn run dev
You should be good to go:
VITE v5.4.3 ready in 290 ms
➜ Local: http://localhost:5173/
➜ Network: use --host to expose
➜ press h + enter to show help
- Enter your data (URL, text, etc.) in the input field.
- (coming soon) Select the type of QR code you want to generate.
- (coming soon) Customize the QR code (optional).
- Your QR code will be displayed. You can download it using the download button.
Contributions are welcome! Here's how you can contribute to this project:
- Fork the project.
- Create your feature branch
git checkout -b feature/FeatureName - Commit your changes
git commit -m 'Added some FeatureName that does some FeatureFunction' - Push to the branch
git push origin feature/FeatureName - Open a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.
- shields.io
- simple icons.
- etc.