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

https://github.com/annaw-99/qr-code

a QR code generator
https://github.com/annaw-99/qr-code

next qrcode-generator react shadcn tailwindcss

Last synced: 21 days ago
JSON representation

a QR code generator

Awesome Lists containing this project

README

        

## QR Code Generator - InstaQR

A modern, customizable QR code generation web application built with Next.js.

### 🛠️ Tech Stack

- Next.js
- TypeScript
- Tailwind CSS
- [Shadcn/UI](https://ui.shadcn.com/) (for components)
- [QRcode.react](https://www.npmjs.com/package/qrcode.react) (for QR code generation)
- Vercel (for deployment)

### ✨ Features

1. Generate QR codes for URLs or text messages
2. Customize the QR code appearance:
- Adjust size
- Set error correction level
- Change foreground and background colors
4. Preview your QR code in real-time
5. Download as a `PNG` file

### 👩🏻‍💻 Getting Started
To run this project locally:

#### Installation

1. Clone the repository:
```bash
https://github.com/annaw-99/qr-code.git
cd qr-code
```

2. Install dependencies:
```bash
npm install
# or
yarn install
```

3. Start the development server:
```bash
npm run dev
# or
yarn dev
```

4. Open your browser and navigate to `http://localhost:3000`

### ☎️ Contact
Feel free to reach out if you have any questions or suggestions!

### 📝 Side Note
Just as friendly heads-up: there are lots of comments throughout this codebase. This was my learning journey with Next.js and React, and I needed those notes to find my way around. Hope they help you understand my thought process too!

### License
This project is licensed under the MIT License - see the LICENSE file for details.