Skip to content
/ favbox Public

πŸ–€ FavBox is a local-first experimental browser extension that enhances and simplifies bookmark management without cloud storage or third-party services.

Notifications You must be signed in to change notification settings

dd3v/favbox

Repository files navigation

FavBox

issues ver license love

image

FavBox is a local-first experimental browser extension that enhances and simplifies bookmark management without cloud storage or third-party services. It extends your browser's native bookmarking features.

Key features:

πŸ”„ sync with your browser profile;
πŸ”’ does not send your data to any third-party services;
🎨 minimalist and clean UI;
🏷 supports tags for easy organization;
πŸ” provides advanced search, sorting, and filtering capabilities based on tags, domains, folders, and webpage keywords;
🌁 multiple display modes;
πŸŒ— light and dark theme;
πŸ—‘οΈ includes a health check function that detects broken URLs;
⌨️ provides quick access to search with hotkeys;
πŸ—’οΈ includes functionality for creating and managing local notes;
❀️ free and open source;

Concept

image

Implementation

FavBox scans all bookmarks in the browser, then makes requests to the saved pages and extracts data from them such as title, description, image, and meta tags to improve the search. All the data is stored in local storage IndexedDB. The extension also tracks all browser events related to bookmarks and synchronizes the data. It only extends the standard functionality and does not attempt to replace it. You can work with bookmarks both through the extension and the native browser’s built-in bookmark features.

FavBox is a fully local application. To keep tags synced across devices, it uses a trick. Since bookmarks are synchronized between devices, to keep tags synchronized, the app adds them to the page title.

For example, if you have a bookmark titled Google Chrome β€” Wikipedia, to save tags across devices, extension appends them to the title like this: Google Chrome β€” Wikipedia 🏷 #wiki #browser

This way, your tags become available on other devices without using any cloud services β€” only through the standard Google Chrome profile sync.

β”œβ”€β”€ public                 # Static assets (icons, etc.)
β”‚Β Β  └── icons
β”œβ”€β”€ src                    # Source code
β”‚Β Β  β”œβ”€β”€ assets             # Global assets
β”‚Β Β  β”œβ”€β”€ components         # Common reusable app components
β”‚Β Β  β”‚Β Β  └── app
β”‚Β Β  β”œβ”€β”€ ext                # Browser extension includes main app, popup, content script, and service worker
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ browser        # FavBox app
β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ components # FavBox components
β”‚Β Β  β”‚Β Β  β”‚Β Β  β”œβ”€β”€ layouts   
β”‚Β Β  β”‚Β Β  β”‚Β Β  └── views
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ content        # Content scripts
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ popup          # Extension PopUp window
β”‚Β Β  β”‚Β Β  └── sw             # Service Worker of the browser extension
β”‚Β Β  β”œβ”€β”€ helpers            # Shared utilities
β”‚Β Β  β”œβ”€β”€ parser             # Library to parse HTML content
β”‚Β Β  β”œβ”€β”€ storage            # IndexedDB storage
β”‚Β Β  β”‚Β Β  └── idb
β”‚Β Β  └── workers            # JS Workers
└── tests
    β”œβ”€β”€ integration
    └── unit

Building

  1. pnpm run build to build into dist
  2. Enable dev mode in chrome://extensions/ and Load unpacked extension

Commands

  • dev Start development server
  • dev:firefox Firefox development build (WIP)
  • build Production build
  • test:unit Run unit tests
  • test:integration Run integration tests

TODO

  • Use SQLite Wasm for storage (ideal for future experiments)
  • Improve transaction implementation (ensure reliability & better performance)
  • The extension already uses a polyfill to maintain compatibility with other browsers. It would be good to test this in Firefox. (WIP)

About

πŸ–€ FavBox is a local-first experimental browser extension that enhances and simplifies bookmark management without cloud storage or third-party services.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published