Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/trashhalo/reddit-rss

improved rss feed for reddit
https://github.com/trashhalo/reddit-rss

pin reddit rss

Last synced: about 6 hours ago
JSON representation

improved rss feed for reddit

Host: GitHub
URL: https://github.com/trashhalo/reddit-rss
Owner: trashhalo
License: mit
Created: 2020-04-04T20:15:29.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2024-04-29T01:27:19.000Z (9 months ago)
Last Synced: 2024-10-11T15:14:19.094Z (3 months ago)
Topics: pin, reddit, rss
Language: Go
Homepage: https://reddit.0qz.fun
Size: 137 KB
Stars: 216
Watchers: 7
Forks: 22
Open Issues: 15
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# reddit-rss

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/trashhalo/reddit-rss)
[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/I3I72N2AC)
[reddit post explaining what this is](https://www.reddit.com/r/rss/comments/fvg3ed/i_built_a_better_rss_feed_for_reddit/)

## Breaking Changes

If you follow this service, please add the announcements rss feed to your reader to be notified of incoming changes.

`https://github.com/trashhalo/reddit-rss/discussions/categories/announcements.atom`

- Limit has been renamed scoreLimit. https://github.com/trashhalo/reddit-rss/issues/46

## installation

Your options are `docker build .` or `go build ./cmd/reddit-rss`.

## using self hosted version

If you run a version of reddit-rss at https://reddit.my.server

If you are interested in using it to you:

1. Go to a subreddit or meta feed you like example: https://www.reddit.com/r/Android/
2. Add .json onto the end: https://www.reddit.com/r/Android.json
3. Change the domain name to, reddit.0qz.fun like: https://reddit.my.server/r/android.json
4. Subscribe to ^^^ that url in your favorite feed reader.

### OAUTH

To get access to better rate limits, you can set up an oauth app on reddit and provide the client id and secret as environment variables.
Be sure to select script when asked what kind of app you are.

```
OAUTH_CLIENT_ID=your_client_id # its that id in the top left of the reddit app page
OAUTH_CLIENT_SECRET=yout_client_secret # its the secret under the id
REDDIT_USERNAME=your_reddit_username # the username of the account you created the app with
REDDIT_PASSWORD=your_reddit_password # the password of the account you created the app with
USER_AGENT="browser:name-of-app:v1.0.0 (by /u/your-reddit-username)"
```

## exposed ports

- 8080 (HTTP)

## query params

- `?safe=true` filter out nsfw posts
- `?scoreLimit=100` filter out posts with less than 100 up votes
- `?flair=Energy%20Products` only include posts that have that flair

## Quick Deploy

[![Deploy with Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Ftrashhalo%2Freddit-rss)

## configuration

to further configure your instance, you can set the following environment variables

### REDDIT_URL

this controls which interface you want your rss feed entries to link to (to avoid tracking and that annoying use mobile app popup). any alternative reddit interface can be provided here, ie: https://libredd.it or https://teddit.net .

it defaults to `"https://old.reddit.com"`.

### PORT

which port your instance is listening on.

defaults to `"8080"`

```