QR Suite Documentation

Welcome to QR Suite docs. This guide covers core features, blog workflow, admin access, and deployment setup.

1. Quick Start

1. Open the app and choose a QR type (Website, PDF, vCard Plus, Social, etc.).
2. Enter your content and customize design.
3. Download or publish.
4. Track scans and update dynamic destinations anytime (for supported types).

2. Supported QR Types

• Website QR
• vCard Plus QR
• PDF QR
• Image QR
• App QR / App deep links
• Business Page QR
• Personal Page QR
• Video QR
• Event QR
• Feedback QR
• Coupons QR
• MP3 QR
• Rating QR
• WiFi QR
• App Store / Play Store QR
• Email / SMS / Phone QR
• Plain text QR
• Social media page QR

3. Blog System

QR Suite blog posts are stored as static HTML files in:

• blog-content/<slug>.html

This keeps blog pages SEO-friendly and simple to serve.

Blog Admin Access

• URL: /admin-blog-section
• Protected by email/password login.
• Direct link is required if admin entry is hidden in UI.

Blog Editor Features

• Rich text formatting
• Heading and list controls
• Link insertion
• Accent text styling
• Themed image blocks (light + dark images)
• Image strips
• Upload image/video directly in article body at cursor position

4. Media Storage

Blog media uploads use:

• Vercel Blob when BLOB_READ_WRITE_TOKEN is configured.
• Local fallback storage only when cloud token is not configured.

Uploaded media URLs are stored in blog content and used on frontend.

5. Hosted Save to GitHub

For hosted environments, blog save can commit HTML directly to GitHub using API.

Required environment variables:

• GITHUB_OWNER
• GITHUB_REPO
• GITHUB_TOKEN (PAT with repository contents write access)
• GITHUB_BRANCH (optional, defaults to main)

When set, saving a blog post updates:

• blog-content/<slug>.html in your GitHub repository.

6. Theme and Branding

• Site supports light/dark mode.
• Blog grid and blog preview can use theme-aware cover images.
• Header logo uses public/vcardly.png with brand color treatment.

7. Legal Pages

• Terms: /terms-and-condition
• Privacy: /privacy-policy

8. Deployment Notes

If deployed on Vercel:

• Configure env vars in Vercel project settings.
• Use Vercel Blob token for cloud media uploads.

If deployed elsewhere:

• GitHub save flow still works with proper env vars.
• Use a compatible cloud media provider/token strategy.

9. Support

For support and legal queries:

• contact@qrsuiteapp.com