https://github.com/dd3v/favbox
❤️FavBox is a browser extension that simplifies and improves bookmark management, without relying on external cloud storage or third-party services
https://github.com/dd3v/favbox
bookmarks bookmarks-manager browser-extension chrome-extension indexeddb productivity sideproject vue3
Last synced: 3 months ago
JSON representation
❤️FavBox is a browser extension that simplifies and improves bookmark management, without relying on external cloud storage or third-party services
- Host: GitHub
- URL: https://github.com/dd3v/favbox
- Owner: dd3v
- Created: 2022-12-30T12:19:53.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-04T11:12:57.000Z (over 1 year ago)
- Last Synced: 2024-07-31T19:55:03.839Z (about 1 year ago)
- Topics: bookmarks, bookmarks-manager, browser-extension, chrome-extension, indexeddb, productivity, sideproject, vue3
- Language: Vue
- Homepage: https://chrome.google.com/webstore/detail/favbox/eangbddipcghohfjefjmfihcjgjnnemj
- Size: 10.5 MB
- Stars: 145
- Watchers: 3
- Forks: 15
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FavBox
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
### 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)