QRBuilder — Documentation

1. Introduction

This document explains how to configure and use the QRBuilder platform — a multi-tenant QR code generation and management system for retailers.

2. Requirements

3. Database Configuration

1. Create a new database (e.g. qrbuilder).
2. Create DB user and assign privileges.
3. Update the .env file with your database credentials:

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=qrbuilder
DB_USERNAME=root
DB_PASSWORD=your_password

4. Environment Configuration

Key .env settings:

APP_URL=https://your-domain.com
MAIL_MAILER=smtp
MAIL_HOST=your-smtp-host
MAIL_PORT=587
MAIL_USERNAME=your-email
MAIL_PASSWORD=your-password

5. Overview

QRBuilder is a multi-tenant QR code generation and management platform. Retailers create dynamic QR codes, design custom templates, track scans with geolocation analytics, and manage sub-users — all governed by a flexible subscription system.

• Admin Panel — System-level management of retailers, subscriptions, QR codes, wallets, and content.
• Retailer Panel — Business-facing interface for creating QR codes, templates, managing users, and viewing analytics.

6. User Roles

7. Admin Panel

Access via /admin

Dashboard

Overview page with system-wide statistics.

Manage QR

• View all QR codes created across the system
• Add, edit, delete, and toggle QR code status (active/inactive)
• View QR scan history with geolocation map

Manage Wallets

• View all retailer wallets and balances
• Wallet transaction history
• Process withdraw requests (approve/reject)

Manage Retailers

• List, add, edit, delete retailers
• Reset retailer passwords
• View retailer's QR products and scan history
• Activate/deactivate retailer accounts

Subscriptions

• Create and manage subscription plans
• Configure features: products, scans, users, buy links, video links, analytics, reviews, overlays
• Set pricing, validity (days), and activation status

Retailer Transactions

View all subscription purchase history across retailers with transaction IDs and amounts.

Messages & FAQs

Manage messages from users and create/edit FAQ entries displayed in the retailer help center.

8. Retailer Panel

Access via / (login page)

Dashboard

Overview with total products, scan statistics, and 7-day scan chart.

My Account

View account info, current subscription usage, and feature access status.

Features & Pricing

Purchase subscription features: number of users, scans, products, plus individual feature toggles.

9. QR Code Management

Creating a QR Code

1. Navigate to Product QR Code → Add
2. Fill in: Title, Response Type (URL / Text / Image), Response Value
3. Optional: Expiration date, Buy link, Video link, Overlay description
4. Submit — system generates a unique slug and product ID

Product ID format: QR0000000001

Response Types

QR Code Design & Download

From the QR listing, click the download icon to customize:

• QR Style — Square, Dot, Round
• Colors — Foreground color, background color
• Eye Style — Square, Circle with separate inner/outer colors
• Logo — Upload or select a logo to embed in the QR center
• Frame — Add frame border with custom color and text (e.g., "SCAN ME")

Designs can be saved and reused across QR codes.

10. Template System

Templates are pre-designed landing pages accessible via QR code scan.

Available Template Types

Creation Flow

1. Select template type
2. Fill in template details (varies by type)
3. Customize QR code design
4. Save — system generates unique slug and template ID

11. Subscription System

Features are gated by subscription plans. Retailers purchase allocations to unlock capabilities.

12. Wallet System

• View current balance and transaction history
• Submit withdraw requests
• Admin approves/rejects withdraw requests

13. User Management

Retailers can create sub-users under their account:

1. Navigate to User Management (profile dropdown)
2. Add users with name, email, and phone number
3. System generates a random password and sends it via email
4. Sub-users inherit the parent retailer's subscription and data

Sub-user limit is controlled by the "number_of_users" subscription allocation.

14. Scan Tracking & Analytics

Every QR code scan records:

• Location — City, state, country, latitude/longitude (via ipstack API)
• Device — Platform type (Desktop/Mobile), browser name
• Network — IP address, access type (Web/App)
• Timestamp — Date and time of scan

View analytics via the "View" (eye icon) on any QR code — 7-day scan chart, country breakdown, and map visualization.

15. Folders

• Create new folders from the sidebar
• Move QR codes into folders
• Rename or delete folders
• Click a folder to filter and view only its QR codes

16. Important URLs