QRwave Documentation

📖 Overview

QRwave is a professional, feature-rich QR code generator built with pure PHP and modern web technologies. It provides an intuitive interface for creating customized QR codes with advanced styling options, live preview, and multiple export formats.

✨ Features

Content Types (8 Options)

• 1 Text - Plain text content
• 2 URL/Website - Direct link to any website
• 3 Email - Email address with subject and body
• 4 Phone - Direct phone number dialing
• 5 SMS - Text message with phone and content
• 6 WiFi - Network credentials (SSID, password, encryption)
• 7 vCard - Contact information (name, org, title, phone, email, website)
• 8 Location - Geographic coordinates with OpenStreetMap search

Styling Options

Branding & Overlays

Frame & Layout

• 🎯 3 frame styles: Simple, Rounded, Badge
• 🎯 Custom frame color
• 🎯 Label text with color customization
• 📐 3 layout options: Controls left, Controls right, Stacked
• 🎨 Theme color picker

Export Formats

🚀 Installation

Server Requirements

PHP 7.4 or higher (PHP 8.x recommended)
Apache or Nginx web server
Internet access for CDN assets (optional - can use local files)

Installation Steps

⚙️ Configuration

All configuration is managed through the config/app.php file. Here's the complete configuration structure:

<?php

return [
    // Application name
    'name' => 'QRwave',
    
    // Default language
    'default_lang' => 'en',
    
    // Available languages
    'languages' => [
        'en' => 'English',
        'es' => 'Español',
        'fr' => 'Français',
        'de' => 'Deutsch',
        'it' => 'Italiano',
        'pt' => 'Português',
        'zh' => '中文'
    ],
    
    // Theme configuration
    'theme' => [
        'primary' => '#6f42c1'  // Primary theme color
    ],
    
    // Map provider settings
    'maps' => [
        'provider' => 'openstreetmap',  // or 'google'
        'google_key' => ''  // Google Maps API key (if using Google)
    ],
    
    // Demo mode settings
    'demo' => [
        'disable_exports' => true  // Disable downloads in demo mode
    ]
];

Configuration Options

📖 Usage Guide

Creating a QR Code

Follow these steps to create a customized QR code:

Content Type Examples

Email QR Code

Email: contact@example.com
Subject: Inquiry
Body: Hello, I'd like to learn more about your services.

WiFi QR Code

SSID: MyNetwork
Password: secret123
Encryption: WPA/WPA2

vCard QR Code

First Name: John
Last Name: Doe
Organization: Acme Inc.
Title: Developer
Phone: +1 555 0100
Email: john@example.com
Website: https://example.com

Location QR Code

Search: "Eiffel Tower, Paris"
Or manually enter:
Latitude: 48.8584
Longitude: 2.2945

🎨 Customization

Theme Colors

Customize the primary theme color by editing config/app.php:

'theme' => [
    'primary' => '#6f42c1'  // Change to your preferred color
]

CSS Customization

Override styles by creating a custom CSS file and including it after app.css:

/* Example: Custom button styles */
.btn-primary {
    background: linear-gradient(135deg, #ff6b6b 0%, #ee5a24 100%);
}

/* Example: Custom card styling */
.card {
    border-radius: 24px;
    box-shadow: 0 8px 40px rgba(0,0,0,0.1);
}

Adding New Languages

// config/app.php
'languages' => [
    'en' => 'English',
    'es' => 'Español',
    'ja' => '日本語'  // Added Japanese
]

🌍 Languages

QRwave supports multiple languages out of the box. Translation files are located in config/lang/.

Available Languages

Translation File Structure

<?php

return [
    'brand' => 'QRwave',
    'tagline' => 'Responsive QR Code generator',
    'nav_home' => 'Generator',
    'nav_demo' => 'Demo',
    'content_title' => 'Content',
    'content_type' => 'Type',
    // ... more translation keys
];

📤 Export Options

QRwave supports three export formats, each optimized for different use cases:

Export Settings

Exports can be disabled in demo mode via configuration:

'demo' => [
    'disable_exports' => true  // Set to false to enable exports
]

🔌 API Reference

QRwave uses the qr-code-styling library for QR code generation. Below are the key configuration options:

QR Code Options

Dots Options

Corner Options

Image Options

🔧 Troubleshooting

Common Issues

Error Messages

❓ FAQ

📋 Changelog

💬 Support

If you need help with QRwave, please follow these steps:

Support Scope

📜 License

QRwave is licensed under the CodeCanyon Regular/Extended License. By purchasing this item, you agree to the following terms:

Regular License

• Use in one end product (end users are not charged)
• Includes future updates
• 6 months support (can be extended to 12 months)

Extended License

• Use in one end product (end users are charged)
• Includes future updates
• 6 months support (can be extended to 12 months)

What You Can Do

• ✓ Use in personal and commercial projects
• ✓ Customize the code to fit your needs
• ✓ Include in SaaS products (with Extended License)

What You Cannot Do

• ✗ Resell or redistribute the item
• ✗ Claim ownership of the code
• ✗ Use in multiple products (purchase additional licenses)

🙏 Credits

QRwave is built using the following open-source libraries and frameworks: