https://github.com/vrugtehagel/gatherss
A simple, free, privacy-friendly RSS aggregator.
https://github.com/vrugtehagel/gatherss
firefox-addon rss rss-aggregator
Last synced: 12 months ago
JSON representation
A simple, free, privacy-friendly RSS aggregator.
- Host: GitHub
- URL: https://github.com/vrugtehagel/gatherss
- Owner: vrugtehagel
- License: mit
- Created: 2025-03-16T23:10:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-18T06:49:02.000Z (about 1 year ago)
- Last Synced: 2025-06-18T07:32:20.767Z (about 1 year ago)
- Topics: firefox-addon, rss, rss-aggregator
- Language: JavaScript
- Homepage: https://addons.mozilla.org/en-GB/firefox/addon/gatherss/
- Size: 29.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GATHERSS
A simple, free, privacy-friendly RSS aggregator, as Firefox addon. No bells, no
whistles. Just links to cool posts.
## Getting started
For local development, not much is needed; there is no build process, so the
extension can be added by navigating to about:debugging and clicking "Load
Temporary Add-on", then selecting the `manifest.json` file.
For the exported ZIP, hidden files must be excluded (most importantly the `.git`
directory) and likewise this `README.md` should be excluded.
```bash
zip -rFS -x=".*" -x="*.md" -x="*.zip" gatherss.zip ./
```
## About the codebase
Things are kept as simple as possible. There are three main parts to any addon;
- The background script (this is `background.js`)
- Content scripts (this is `content.js`)
- The browser action (this is everything under `action/`)
The browser action is a popup, so the files under `action/` are the different
pages. The initial page, i.e. the one you see when clicking the action button,
is `action/index.html`. All the pages share the `action/action.css` stylesheet,
but also have their own `index.css`.
The bulk of the actual logic happens in separate files in `-/`; functions are
split over different files to make things a bit clearer.
There are some SVG icons under `icons/`; these are referenced through `![]()
` or
by path in case of the browser action button.
The `.thumbnail.*` files are used for the listing on
[addons.mozilla.org](https://addons.mozilla.org) - they are kept for version
control, but should not be included in the submitted ZIP (which is why they are
hidden files).