An open API service indexing awesome lists of open source software.

https://github.com/zouari-oss/qr-me

QRME is a simple and customizable QR code generator web application
https://github.com/zouari-oss/qr-me

bootstrap5 cdnjs css3 html5 js qrcode qrcode-generator qrcodejs

Last synced: 28 days ago
JSON representation

QRME is a simple and customizable QR code generator web application

Awesome Lists containing this project

README

          

# QRME - QR Code Generator

QRME is a simple and customizable QR code generator web application. It allows users to create QR codes for different types of data easily. This project uses HTML5, Bootstrap, Sass, and JavaScript, with the `qrcodejs` library to generate the QR codes.


Home

## Technologies Used

![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)
![Git](https://img.shields.io/badge/git-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white)
![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)
![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white)
![CSS3](https://img.shields.io/badge/css3-%231572B6.svg?style=for-the-badge&logo=css3&logoColor=white)
![SASS](https://img.shields.io/badge/SASS-hotpink.svg?style=for-the-badge&logo=SASS&logoColor=white)
![Bootstrap](https://img.shields.io/badge/bootstrap-%238511FA.svg?style=for-the-badge&logo=bootstrap&logoColor=white)
![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)

## Features

- Generate QR codes for various types of data (URLs, text, etc.)
- Fully responsive design using Bootstrap
- Customizable styling with Sass
- Live preview of the generated QR code
- Downloadable QR codes in different sizes and formats

## Project Structure
```bash
.QRME
├── doc
├── github
├── pkg
└── project
├── public
│   ├── assets
│   ├── cmd
│   ├── css
│   ├── html
│   ├── js
│   └── sass
└── res

13 directories
```

## Installation and Setup

1. Clone the repository:
```bash
git clone https://github.com/ZouariOmar/QRME.git
```
2. Open the `index.html` file in your browser to run the application locally.

3. Customize the application by editing the Sass files, then compile them to CSS using your preferred Sass compiler.

## Usage

1. Enter the desired data (text, URL, etc.) into the input field.
2. Adjust the QR code size and style options as needed.
3. Click the "Generate QR Code" button to create the QR code.
4. Use the download button to save the generated QR code image.

## Credits

- **QRCode.js**: [QRCode.js Library](https://davidshimjs.github.io/qrcodejs)

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.