Skip to content

A real-time web performance analyzer extension that identifies bottlenecks, suggests optimizations, and monitors Core Web Vitals. Integrates with DevTools to help developers build lightning-fast websites and ensure a high-performance user experience.

License

Notifications You must be signed in to change notification settings

chirag127/VelocityRay-Web-Performance-Analyzer-Browser-Extension

Repository files navigation

VelocityRay: Real-Time Web Performance Analyzer (Browser Extension)

A cutting-edge browser extension for real-time web performance analysis. VelocityRay pinpoints bottlenecks, suggests actionable optimizations, and integrates seamlessly with browser DevTools to monitor Core Web Vitals, ensuring a lightning-fast user experience.

Build Status Code Coverage TypeScript Version Vite Version Tauri Version License: CC BY-NC 4.0 GitHub Stars


Star ⭐ this Repo to Support Future Development!


πŸš€ Project Overview

VelocityRay is engineered to empower developers and website owners with deep insights into their web application's performance. By leveraging advanced browser APIs and analytical techniques, it provides immediate feedback on critical performance metrics, making it easier than ever to diagnose and resolve speed-related issues.


🌳 Architecture

ascii . β”œβ”€β”€ src/ β”‚ β”œβ”€β”€ background/ # Background service worker for extension logic β”‚ β”‚ └── index.ts β”‚ β”œβ”€β”€ content/ # Injected scripts for page interaction β”‚ β”‚ β”œβ”€β”€ devtools.ts # DevTools panel integration β”‚ β”‚ └── page.ts # Page script for performance metrics β”‚ β”œβ”€β”€ popup/ # User interface for the extension popup β”‚ β”‚ └── main.ts β”‚ β”œβ”€β”€ store/ # State management (e.g., using Signals or Zustand) β”‚ β”‚ └── index.ts β”‚ β”œβ”€β”€ utils/ # Utility functions β”‚ β”‚ └── metrics.ts β”‚ └── main.ts # Extension entry point β”œβ”€β”€ static/ # Static assets (icons, manifest.json) β”‚ β”œβ”€β”€ icons/ β”‚ └── manifest.json β”œβ”€β”€ .env # Environment variables β”œβ”€β”€ biome.json # Biome configuration β”œβ”€β”€ package.json # Project dependencies and scripts β”œβ”€β”€ tsconfig.json # TypeScript configuration β”œβ”€β”€ vite.config.ts # Vite build configuration └── README.md # This file


πŸ“– Table of Contents


πŸ€– AI Agent Directives

View Agent Directives

This repository is managed by the Apex Technical Authority AI Agent, operating under the December 2025 Edition protocols.

🎯 Prime Directive

  • Role: Senior Principal Software Architect, Master Technical Copywriter, DevOps Strategist (40+ years elite experience).
  • Output Standard: EXECUTION-ONLY. Enforce FAANG-level standards and "Managing the Unmanageable."
  • Philosophy: "Zero-Defect, High-Velocity, Future-Proof."

πŸ› οΈ Tech Stack & Toolchain (Late 2025 Standards)

  • Project Type: Browser Extension / Web App.
  • Language: TypeScript 6.x (Strict Mode enforced).
  • Bundler/Build Tool: Vite 7 (utilizing Rolldown).
  • Native Integration (Optional): Tauri v2.x for potential desktop packaging.
  • Extension Framework: WXT (Web Extension Tooling) or Vite's native extension support.
  • State Management: Signals (Standardized), or Zustand for simplicity if Signals are overkill.
  • Styling: TailwindCSS v4.

βš™οΈ Linting & Formatting

  • Tool: Biome (v1.7.0+). Ensures ultra-fast, unified code quality checks and formatting.
  • Configuration: Managed via biome.json, enforcing strict rules.

πŸ§ͺ Testing Strategy

  • Unit Testing: Vitest (v2.x+). Leverages Vite's ecosystem for rapid unit tests.
  • End-to-End (E2E) Testing: Playwright (v1.x+). For comprehensive browser automation and E2E scenario validation.
  • Coverage: Codecov.io integration via CI/CD pipeline.

πŸ“ Architectural Patterns

  • Core Principles: SOLID, DRY, YAGNI.
  • Frontend Structure: Feature-Sliced Design (FSD) for modularity and scalability.
  • Extension Structure: Adheres to standard browser extension architecture (background scripts, content scripts, popup UI).

πŸš€ Deployment & CI/CD

  • Platform: GitHub Actions.
  • Workflow: ci.yml orchestrates linting, testing, building, and deployment tasks.

πŸ” Verification Commands

  • Lint & Format: npm run lint -- --fix or biome check --apply
  • Unit Tests: npm run test:unit or vitest run
  • E2E Tests: npm run test:e2e or npx playwright test
  • Build: npm run build

πŸ› οΈ Development Standards

Prerequisites

  • Node.js (v20.x LTS or higher recommended)
  • npm (v10.x+) or Yarn (v4.x+)

Installation

  1. Clone the repository: bash git clone https://github.com/chirag127/VelocityRay-Web-Performance-Analyzer-Browser-Extension.git cd VelocityRay-Web-Performance-Analyzer-Browser-Extension

  2. Install dependencies using npm: bash npm install

Development Commands

Command Description
npm run dev Starts the Vite development server for the extension.
npm run build Builds the extension for production.
npm run lint Runs Biome to check code style and quality.
npm run lint:fix Fixes linting and formatting issues automatically.
npm run test:unit Executes unit tests using Vitest.
npm run test:e2e Runs end-to-end tests using Playwright.

Principles

  • SOLID: Adhere to the Single Responsibility, Open/Closed, Liskov Substitution, Interface Segregation, and Dependency Inversion principles.
  • DRY (Don't Repeat Yourself): Minimize code duplication.
  • YAGNI (You Ain't Gonna Need It): Implement only what is currently required.

πŸ“œ License

This project is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License (CC BY-NC 4.0). See the LICENSE file for more details.

About

A real-time web performance analyzer extension that identifies bottlenecks, suggests optimizations, and monitors Core Web Vitals. Integrates with DevTools to help developers build lightning-fast websites and ensure a high-performance user experience.

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •