Skip to content

Fox Recap is a powerful browser extension designed to help users analyze and understand their browsing habits.

License

Notifications You must be signed in to change notification settings

Firefox-Recap/Fox-Recap

Repository files navigation

Fox Recap

[INSTRUCTUIONS MAY BE OUTDATED]

Fox Recap is a browser extension that analyzes and visualizes your browsing history. It fetches your history, categorizes pages via an on‑device ML model, and presents insights—like your most visited sites, peak browsing times, category trends, and transition patterns—in an interactive slideshow.irefox Recap

Firefox Recap is a browser extension that analyzes and visualizes your Firefox browsing history. It fetches your history, categorizes pages via an on‑device ML model, and presents insights—like your most visited sites, peak browsing times, category trends, and transition patterns—in an interactive slideshow.

Features

  • Fetch & store browsing history for a configurable time window (day, week, month)
  • ML‑powered URL & title classification using an on‑device model URLTITLE-classifier
  • Store data in IndexedDB using Dexie for efficient queryin
  • Handlers for:
    • Unique website count
    • Most visited sites
    • Recency & frequency metrics
    • Visits per hour histogram
    • Daily visit counts
    • Category trends over time
    • URL‑to‑URL transition patterns
  • Interactive slideshow UI built with React and Recharts

Prerequisites

  • A compatible browser (Firefox Nightly recommended)
  • Enable these flags in about:config:
    • browser.ml.enable → true
    • extensions.ml.enabled → true
  • Node.js (v18+) and npm

Installation

git clone https://github.com/Fox-Recap/Fox-Recap.git
cd Fox-Recap
npm install

Loading the Extension

  1. Open about:debugging in your browser
  2. Click Load Temporary Add-on
  3. Select dist/manifest.json
  4. Ensure ML flags are enabled and refresh the extension

Development

  • Start a dev build with live reloading:
    npm run dev
  • Generate documentation:
    npm run docs
    npm run docs:serve
  • Run tests:
    npm test
  • Build production extension:
    npm run build
    npm run build:ext

Usage

  1. Click the toolbar icon to open the popup
  2. Select a time range (day, week, or month)
  3. Sit back and enjoy the slideshow of your browsing recap!
  4. Navigate slides with the arrow buttons or close with “×”

Contributing

Issues and pull requests are welcome! Please use our GitHub Issues page.

License

This project is licensed under the GNU GPLv3 License. See the LICENSE file for details.


About

Fox Recap is a powerful browser extension designed to help users analyze and understand their browsing habits.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 5