cztchoice/omnivore-list-popup

Web extension for Firefox and Chrome that shows a popup with a list of your Omnivore articles to quickly open or archive.

Omnivore List Popup Web Extension (Firefox & Chrome)

Show a popup with a list of your Omnivore articles to quickly open or archive.

Installation & Usage

1. Install the extension from the Firefox Extensions page or the Chrome Web Store.
2. Get an Omnivore API Key through your Omnivore Account.
3. Go into the extension’s settings and paste your Omnivore API key.
4. Launch the extension by clicking the new "Omnivore List Popup" button in your extension toolbar/dropdown.
5. Optional: Add the extension to your always-visible toolbar.

Development Setup

1. Install the Node version defined in .nvmrc (e.g. with nvm use).
2. Install dependencies with npm install.
3. Run npm run prepare-manifest -- -firefox (or -chrome) to create the browser-specific manifest.json.
4. Run the build with npm run build to generate the output files.
5. Load the extension folder in Firefox and/or Chromium.

Development Commands

• Run npm run dev to watch files for changes and re-run the build.
• Run npm run format to format the code with Prettier.
• Run npm run lint to lint the code with ESLint.

Releasing

Firefox:

1. Run npm run prepare-manifest -- -firefox to create the Firefox-specific manifest.json.
2. Run npm run create-release to generate the output files and create the extension archives.
3. Upload the archives on https://addons.mozilla.org/developers/addon/omnivore-list-popup/

Chrome:

1. Run npm run prepare-manifest -- -chrome to create the Chrome-specific manifest.json (Manifest v3).
2. Run npm run create-release to generate the output files and create the extension archives.
3. Upload the archives on https://chrome.google.com/webstore/devconsole

Contributing

If you have ideas or issues, please get in touch! You can either use GitHub issues or contact herrherrmann directly.

Todos & Ideas

• Add pagination to browse beyond 10 items (issue #23)
• Improve onboarding, e.g. make it possible to enter API key in popup
• Improve error handling
• Use Omnivore’s savePage API instead of saveUrl (to capture page content directly)
• Internationalization
• Cache list items locally for offline usage
• Highlight the popup button if the current page is added to Omnivore

Acknowledgements

• Thanks to the amazing In My Pocket extension for inspiring this project. 👏
• Thanks to the Omnivore team for the nice Pocket alternative and open API.
• Thanks to the Lucide project for the icon set.