A clean, feature-rich, open-source QR code generator with custom styling and advanced features.

• Custom colors with gradient support
• Multiple pattern styles (dots, squares, rounded)
• Logo integration
• Frame options with custom text
• Advanced error correction levels

• Node.js 18+ and npm/yarn
• Git

1. Clone the repository

git clone https://github.com/Darkmintis/OpenQR.git
cd OpenQR

2. Install dependencies

npm install
# or
yarn install

3. Run the development server

npm run dev
# or
yarn dev

4. Open http://localhost:3000 in your browser to see the application.

• Framework: Next.js 15 with App Router
• Language: TypeScript with strict configuration
• Styling: Tailwind CSS with custom components
• QR Generation: qrcode library with html2canvas for exports
• Deployment: GitHub Pages (static export)
• CI/CD: GitHub Actions for automated deployment

OpenQR/
├── src/
│   ├── app/                  # Next.js app directory
│   │   ├── privacy/          # Privacy policy page
│   │   └── terms/            # Terms of service page
│   ├── components/           # React components
│   │   ├── layout/           # Layout components
│   │   ├── providers/        # Context providers
│   │   ├── qr/               # QR generation components
│   │   ├── sections/         # Page sections
│   │   └── ui/               # UI components
│   ├── lib/                  # Utility functions
│   └── types/                # TypeScript definitions
└── public/                   # Static assets

OpenQR is deployed using GitHub Pages for static site hosting. The deployment is automated through GitHub Actions.

You can try the live application here: https://darkmintis.dev/openqr

The application is automatically built and deployed to GitHub Pages when changes are pushed to the main branch. The GitHub Actions workflow handles:

1. Building the Next.js application with static export
2. Configuring the correct base path for GitHub Pages
3. Deploying the built files to the gh-pages branch

Contributions are welcome! Please feel free to submit a Pull Request.

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

OpenQR is designed with privacy in mind:

• All QR code generation happens entirely in your browser
• No data is sent to any servers
• All processing is done locally on your device

For more details, please see our Privacy Policy and Terms of Service.

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

• Next.js - The React Framework
• Tailwind CSS - A utility-first CSS framework
• QRCode.js - QR Code generator library