Initial commit of CK-QR Platform
This commit is contained in:
Mohan Ki
@@ -0,0 +1,92 @@
|
||||
# Product Scope Document: CK-QR Platform
|
||||
|
||||
**Project Name:** CK-QR
|
||||
**Document Version:** 1.0
|
||||
**Prepared by:** Cavin Infotech Pvt. Ltd.
|
||||
|
||||
## 1. Executive Summary
|
||||
**Product Objective:** To develop and deploy a comprehensive, scalable SaaS platform that allows users to generate, customize, manage, and track Static and Dynamic QR codes.
|
||||
**Target Audience:** Individual users, marketers, and enterprise businesses requiring centralized QR code management, custom branding, and real-time scan analytics.
|
||||
**Monetization Strategy:** A freemium model where basic and dynamic generation is free (ad-supported routing), driving conversions to paid tiers for ad-free scanning, custom domains, and advanced analytics.
|
||||
|
||||
## 2. Core Functional Modules (In-Scope)
|
||||
|
||||
### A. User Management & Authentication
|
||||
* **Authentication:** Registration/Login via Email, Google SSO, and Apple SSO.
|
||||
* **Role-Based Access:** System must support Guest (unregistered), Free, Trial, Pro, and Enterprise user states.
|
||||
* **Team Workspaces:** Multi-seat management for Enterprise tiers to collaborate on shared QR campaigns.
|
||||
|
||||
### B. QR Code Generation Engine
|
||||
* **Dynamic QR Codes:** URL routing system allowing users to update destination content post-generation without altering the printed QR image.
|
||||
* **Supported Data Types:**
|
||||
* *Standard/Open-Source:* URL, vCard/MeCard, Text, Email (`mailto:`), SMS (`sms:`), Phone Call (`tel:`), Wi-Fi (WPA/WEP/Hidden), Location (Geo URI), Event (vCalendar/iCalendar), and GS1 Digital Link.
|
||||
* *Dynamic/Custom:* PDF/Document (including Excel/PPTX), App Store routing (OS-dependent), Image Galleries, Social Media (Link in Bio), Audio/Video (YouTube/MP3), Crypto Wallet addresses, Messaging (WhatsApp/Telegram/Line), Payments (UPI/PayPal), Forms & Surveys (Google Forms/Microsoft Forms), and Multi-URL/Conditional Routing (routing based on OS, time, location, or scan limits).
|
||||
|
||||
### C. QR Customization Studio
|
||||
* **Design Templates:** Library of pre-configured multiple design templates for various industries and use-cases (e.g., sleek, playful, corporate).
|
||||
* **Visual Editor (Patterns & Eyes):** Advanced interface for modifying data patterns (e.g., dots, squares, rounded, liquid) and customizing corner eye/frame shapes (outer and inner eye styling).
|
||||
* **Color & Branding:** Support for single colors, linear/radial gradients, background colors, and transparent backgrounds.
|
||||
* **Custom Logo Integration:** Central logo placement with support for custom image uploads, social media presets (Facebook, Instagram, LinkedIn, etc.), automatic background removal behind the logo, and logo resizing/scaling.
|
||||
* **Frames & Call-To-Action:** Pre-designed customizable frames with integrated call-to-action text (e.g., "Scan Me", "View Menu", "Get Wi-Fi") and editable fonts/colors.
|
||||
|
||||
### D. QR Management Dashboard
|
||||
* **Asset Organization:** Folders and tagging systems for campaign management.
|
||||
* **Dynamic Controls:** Update destination URLs, temporarily pause campaigns (routes to a "Campaign Ended" holding page), or archive codes.
|
||||
* **Bulk Operations:** Delete, categorize, or download multiple QR codes simultaneously.
|
||||
|
||||
### E. Scan Analytics & Tracking
|
||||
* **Metrics:** Total scans, unique devices, operating system breakdown, and location tracking (Country/City).
|
||||
* **Visualization:** Time-based charts (day/week/month).
|
||||
* **Data Export:** CSV exports for external reporting.
|
||||
* **Integrations:** Advanced tracking integration via Google Analytics and Meta Pixel for retargeting and deeper user insights.
|
||||
|
||||
### F. Web-Based QR Scanner
|
||||
* **In-Browser Scanning:** A dedicated web interface utilizing device cameras (webcam/smartphone) to scan QR codes without requiring a native mobile app download.
|
||||
* **Scan History:** Keeping a session or local log of recently scanned codes for the user.
|
||||
|
||||
## 3. Account Tier & Subscription Architecture
|
||||
The platform operates on a tiered structure, utilizing a robust downgrade logic to ensure dynamic links remain functional even if subscriptions lapse.
|
||||
|
||||
| Feature / Capability | Guest / Free | Free Trial (14-Day) | Pro / Enterprise Paid |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| **Static QR Codes** | Unlimited | Unlimited | Unlimited |
|
||||
| **Dynamic QR Codes** | Up to 5 | Unlimited | Unlimited |
|
||||
| **Scan Interstitial Ads** | Yes (Ad-supported) | No Ads | No Ads |
|
||||
| **Custom Domains** | CK-QR domain only | Custom subdomains | Custom domain / White-label |
|
||||
| **Export Formats** | PNG, JPEG | PNG, JPEG, SVG, PDF | All + Bulk zip export |
|
||||
| **File Storage Limit** | 5 MB per upload | 20 MB per upload | 100 MB - 1 GB+ per upload |
|
||||
|
||||
**Trial Expiration Logic:**
|
||||
When a 14-day Pro Trial expires without payment, the account is downgraded to the Free Tier. Dynamic links do not break. Instead, the routing behavior reverts to ad-supported mode (serving a 3–5 second interstitial ad before redirecting) and vector exports are locked.
|
||||
|
||||
## 4. Technical Architecture & Infrastructure
|
||||
To handle high-volume concurrent scans, rapid URL redirection, and secure data handling, the system will utilize a modern, highly available stack.
|
||||
|
||||
* **Frontend UI:** React.js / Next.js for a responsive dashboard and SEO-optimized landing pages.
|
||||
* **Backend API:** Node.js backend executing asynchronous, non-blocking requests for rapid link routing and QR generation.
|
||||
* **Process Management:** PM2 will be utilized for Node.js process management, clustering, and ensuring backend zero-downtime restarts.
|
||||
* **Deployment & Networking:** The application will be containerized using Docker. Nginx will serve as the reverse proxy and load balancer to manage incoming scan traffic and route it to the appropriate backend containers.
|
||||
* **Database Engine:** PostgreSQL for relational user and billing data, paired with a Redis caching layer for active dynamic URLs to ensure sub-second redirection latency.
|
||||
* **Storage & CDN:** AWS S3 or Cloudflare R2 for storing user-uploaded assets (logos, PDFs) and serving them globally.
|
||||
|
||||
## 5. Development Phases
|
||||
|
||||
* **Phase 1: Foundation & Core Engine (Weeks 1-4)**
|
||||
Database schema design, Node.js API setup, authentication workflows, and the core QR generation and routing logic.
|
||||
* **Phase 2: Customization Studio & Dashboard (Weeks 5-8)**
|
||||
Frontend development of the React.js dashboard, visual QR customization studio, folder management, and user asset storage.
|
||||
* **Phase 3: Subscription & Analytics (Weeks 9-11)**
|
||||
Integration of the payment gateway (e.g., Stripe), trial expiration logic, ad-interstitial middleware, and scan analytics tracking.
|
||||
* **Phase 4: Optimization & Launch (Weeks 12-14)**
|
||||
Docker containerization, Nginx configuration, PM2 load testing for high-concurrency scans, QA testing, and production deployment.
|
||||
|
||||
## 6. Out of Scope (Phase 1)
|
||||
* Native iOS and Android mobile applications.
|
||||
* Public API access for third-party developers.
|
||||
* Complete white-labeling of the dashboard for enterprise resellers.
|
||||
|
||||
## 7. Assumptions & Risks
|
||||
* **Link Spam & Abuse:** Malicious actors may use free dynamic QRs for phishing.
|
||||
* *Mitigation:* Implement automated URL scanning (e.g., Google Safe Browsing API) upon creation and enforce email verification for dynamic creation.
|
||||
* **Ad-Blocker Interference:** Browser ad-blockers may prevent the ad-supported redirect logic from firing.
|
||||
* *Mitigation:* Server-side routing delays rather than client-side ad rendering for free tiers.
|
||||
Reference in New Issue
Block a user