https://github.com/lwindolf/rss-finder

Easily discover RSS feeds
https://github.com/lwindolf/rss-finder

atom feed-reader rss

Last synced: 6 months ago
JSON representation

Easily discover RSS feeds

• Host: GitHub
• URL: https://github.com/lwindolf/rss-finder
• Owner: lwindolf
• License: unlicense
• Created: 2025-03-17T12:51:53.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-09-24T00:37:28.000Z (7 months ago)
• Last Synced: 2025-09-24T01:12:39.087Z (7 months ago)
• Topics: atom, feed-reader, rss
• Language: JavaScript
• Homepage: https://lwindolf.github.io/rss-finder/
• Size: 539 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# RSS Finder

A simple web component finding RSS feeds for different sources.

Intended to be embedded into feed reader apps.

## Embed via iframe

    

## Embed as a webcomponent

1. `npm run build`

2. Copy the `www` directory to your code base as `rss-finder`

3. Include the sources 

        

        

4. Use the `` custom HTML element in your web app.

## Configuration Parameters

The following configuration parameter can be passed to an iframe via query

string or to the web component as attributes. For example

     https://lwindolf.github.io/rss-finder?show-title=false&scheme=web%2Bfeed%3A

or

     

     

The following parameters are supported

| Parameter         | Description                                                     | Default          |

|-------------------|-----------------------------------------------------------------|------------------|

| show-title        | Whether to add a `
` title                                   | `true`           |

| icon-path         | Path to subscriber icons (adapt it when using as webcomponent)  | `icons`          |

| scheme            | Which URI scheme to trigger for subscriptions                   | `feed:`          |

| use-cors-proxy    | Whether to retry using a CORS proxy when a network error occurs | `false`          |

| cors-proxy        | URL of a cors proxy to use                                      | `https://corsproxy.io/` |


## Privacy considerations

### CORS proxy

Per default `use-cors-proxy` is disabled, so everything happens at the user side. This

is ok for e.g. Electron apps or native apps with embedded browser widgets which can 

disable CORS internally.

If you want to use RSS finder in a pure web app the browser CORS settings will disallow

access to almost all feeds and you will need to enable the cors-proxy. In this case ensure

your users know about the privacy impact (e.g. Cloudflare hosting corsproxy.io potentially 

knowing about the feeds they subscribe to).

### Accessing 3rd party APIs

Some sources access 3rd party APIs for example 

- iTunes

- Mastodon

- BlueSky

- Lemmy