Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/flytaly/reddit-post-notifier

Firefox/Chrome extension that watches for posts in given subreddits or reddit searches
https://github.com/flytaly/reddit-post-notifier

chrome-extension firefox-extension notifications reddit

Last synced: 3 months ago
JSON representation

Firefox/Chrome extension that watches for posts in given subreddits or reddit searches

Host: GitHub
URL: https://github.com/flytaly/reddit-post-notifier
Owner: flytaly
License: mpl-2.0
Created: 2019-02-16T14:21:03.000Z (almost 6 years ago)
Default Branch: main
Last Pushed: 2024-05-15T19:44:38.000Z (9 months ago)
Last Synced: 2024-05-16T12:16:27.064Z (9 months ago)
Topics: chrome-extension, firefox-extension, notifications, reddit
Language: TypeScript
Homepage:
Size: 4.24 MB
Stars: 18
Watchers: 5
Forks: 6
Open Issues: 15
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # Reddit post notifier

![Chrome Web Store](https://img.shields.io/chrome-web-store/v/hoolgoecmeegpbidbbcefgkjegdejibd)

![Chrome Web Store](https://img.shields.io/chrome-web-store/stars/hoolgoecmeegpbidbbcefgkjegdejibd)

![Chrome Web Store](https://img.shields.io/chrome-web-store/users/hoolgoecmeegpbidbbcefgkjegdejibd)

![Mozilla Add-on](https://img.shields.io/amo/v/reddit-post-notifier)

![Mozilla Add-on](https://img.shields.io/amo/stars/reddit-post-notifier)

![Mozilla Add-on](https://img.shields.io/amo/users/reddit-post-notifier)

[ ![chrome.google.com/](https://i.imgur.com/unvdmLG.png)](https://chrome.google.com/webstore/detail/reddit-post-notifier/hoolgoecmeegpbidbbcefgkjegdejibd)

[ ![addons.mozilla.org/](https://user-images.githubusercontent.com/1577569/225926070-baa9ed48-841c-4ce7-bf70-557f848eed23.png)](https://addons.mozilla.org/firefox/addon/reddit-post-notifier/)

A browser extension that watches and notifies about:

-   **new posts** in subreddits and Reddit searches,

-   unread **private messages** in multiple accounts,

-   the latest **users' comments and posts**.

[![Video demonstration](https://img.youtube.com/vi/PZ69Vljtrg8/0.jpg)](https://www.youtube.com/watch?v=PZ69Vljtrg8)

Also check out my other web extension to search in your Reddit saved posts: [Reddix](https://github.com/flytaly/reddix-extension).

## 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](https://github.com/reddit-archive/reddit/wiki/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](https://www.reddit.com/prefs/apps/), 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](https://github.com/sveltejs/svelte) + [Tailwind CSS](https://tailwindcss.com/) and bundled with [Vite](https://github.com/vitejs/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](LICENSE).