flytaly / reddit-post-notifier

Firefox/Chrome extension that watches for posts in given subreddits or reddit searches
Mozilla Public License 2.0
20 stars 5 forks source link
chrome-extension firefox-extension notifications reddit

Reddit post notifier

Chrome Web Store Chrome Web Store Chrome Web Store

Mozilla Add-on Mozilla Add-on Mozilla Add-on

chrome.google.com/ addons.mozilla.org/

A browser extension that watches and notifies about:

Video demonstration

Also check out my other web extension to search in your Reddit saved posts: Reddix.

Usage for developers

Install dependencies with npm install.

Then, to build and watch changes to the code and style files, and run the corresponding browser using web-ext

npm run dev:ff
npm run dev:chrome

To build the extension in the "extension" folder.

npm run build:ff
npm run build:chrome

To archive the contents of the "extension" folder as a package in the /web-ext-artifacts folder

npm run zip

Authorization (optional)

This extension uses OAuth2 authentication to get authorization and refresh tokens. These tokens will be used to check reddit private messages for multiple accounts. To generate credentials create new reddit app, and add id of the app in .env file (see .env.example).

External libraries and frameworks

The pop-up and option pages UI are made with Svelte + Tailwind CSS and bundled with Vite.

Keyboard shortcuts

Key Function
Alt+Shift+S Open the extension's popup
, j Select the next item
, k Select the previous item
, l, Enter Expand selected posts group; open selected item in the new tab
, h, Backspace Collapse selected posts group
Space Mark selected item as read (remove it)
p Pin selected post; remove already pinned post

License

The code of the extension is licensed under the MPL-2.0.