🌟 QuantumCode-Dynamic-QR-Generator-Web-Utility 🌟

A high-performance, modern TypeScript utility for generating dynamic and complex QR codes, leveraging Vite and best-in-class browser APIs.

---

💡 Project Overview: The QuantumCode Engine

QuantumCode is a zero-dependency, high-speed web utility designed to generate complex, customizable QR codes instantly in the browser. Leveraging the power of modern frameworks like Vite and enforcing strict TypeScript safety, this tool ensures optimal rendering performance and reliability for mission-critical data encoding.

Core Features

• Dynamic Encoding: Supports various data types (URLs, text, contacts, Wi-Fi configuration) with real-time feedback.
• Customization: Advanced options for error correction levels, module size, color, and background transparency.
• High Performance: Optimized rendering pipeline using Canvas/SVG for superior speed and small footprint.
• Zero-Dependency Core: Built for maximum performance and minimum bundle size.

🏛️ Architecture: Feature-Sliced Design (FSD)

This project adheres to the Feature-Sliced Design (FSD) methodology, ensuring maximum scalability, clear boundary enforcement, and maintainable codebase separation.

mermaid graph TD A[QuantumCode Utility Entry] --> B(Router/Core Logic); B --> C{Features Layer}; C --> C1[F: Code Generation]; C --> C2[F: Dynamic Configuration]; C --> C3[F: Output & Download]; C1 --> D(Shared Kernel/Libraries); C2 --> D; C3 --> D; D --> E[External Browser APIs];

🛠️ Getting Started

This project uses pnpm for efficient package management.

Prerequisites

Ensure you have Node.js (LTS recommended) and pnpm installed.

Installation & Setup

bash

1. Clone the repository

git clone https://github.com/chirag127/QuantumCode-Dynamic-QR-Generator-Web-Utility cd QuantumCode-Dynamic-QR-Generator-Web-Utility

2. Install dependencies

pnpm install

3. Start the development server (Vite HMR)

pnpm dev

Available Scripts

Script	Description	Standard	Notes
pnpm dev	Starts the local development server with hot module replacement.	Development	Runs on http://localhost:5173
pnpm build	Compiles and bundles the application for production deployment.	Production	Output directory: ./dist
pnpm lint	Runs Biome to check code style and apply formatting.	CI/CD	Zero warnings required
pnpm test	Executes unit tests via Vitest and generates coverage reports.	Verification	Coverage threshold enforced
pnpm test:e2e	Runs end-to-end tests using Playwright.	Verification	Requires prior pnpm build

🤖 AI AGENT DIRECTIVES

📐 Architectural Blueprint for Automated Agents (SSOT)

Agent Alignment Protocol

All contributing and automated agents MUST strictly adhere to the standards outlined in AGENTS.md and the following configuration:

1. Technology Stack Definition (The Apex Toolchain):

   • Core Language: TypeScript (Strict Mode enforced via tsconfig.json).
   • Bundler/Dev Server: Vite (utilizing Rolldown integration for production). Configuration must prioritize tree-shaking and module federation readiness.
   • Styling: TailwindCSS v4 (Utility-first approach, JIT mode).
   • Package Manager: pnpm for speed and efficient dependency handling.

2. Architectural Patterns:

   • Primary Pattern: Feature-Sliced Design (FSD). All new components must be placed correctly within layers (e.g., app/, pages/, features/, entities/, shared/).
   • Design Principles: Strict adherence to SOLID principles. Components must be atomic, idempotent, and reusable (DRY).
   • State Management: Use modern signaling mechanisms (or context/hooks for React) for reactive state. Avoid complex, centralized global stores unless absolutely necessary.

3. Verification and Quality Gates:

   • Linting/Formatting: Must pass pnpm lint (Biome configuration) with zero errors/warnings.
   • Testing Protocol: All features must achieve 90%+ test coverage. Unit tests run via Vitest. E2E tests run via Playwright. Code must not be merged without successful execution of pnpm test and pnpm test:e2e.

🤝 Contributing

We welcome high-quality contributions! Please review the Contributing Guidelines before submitting Pull Requests. All submissions must pass CI/CD pipeline checks.

📜 License

Distributed under the Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0) License. See LICENSE for more information.

---