marc/rss-reader
1
0
Fork 0
Code Issues 5 Pull requests 10 Projects Releases Packages Wiki Activity
Yet Another RSS Reader 🏴‍☠️
20 commits 11 branches 0 tags 6 MiB
TypeScript 95.6%
JavaScript 2.6%
HTML 1.5%
Shell 0.3%
Find a file
Marc Cataford 55f3566190
build: node, yarn updates (#21) 
* build: node, yarn ups

* docs: update

* build: yarn update
2021-10-15 23:15:21 -04:00
.github/workflows feat: organize in feeds, sort by date (#12) 2021-07-25 14:18:16 -04:00
.yarn/releases build: node, yarn updates (#21) 2021-10-15 23:15:21 -04:00
assets docs: diagram (#5) 2021-07-17 13:00:02 -04:00
netlify/functions/rss-proxy fix: chunked responses (#19) 2021-08-02 11:42:45 -04:00
script build: node, yarn updates (#21) 2021-10-15 23:15:21 -04:00
src fix: chunked responses (#19) 2021-08-02 11:42:45 -04:00
.eslintrc.js refactor: react to preact (#15) 2021-08-02 01:26:24 -04:00
.gitattributes docs: diagram (#5) 2021-07-17 13:00:02 -04:00
.gitignore build: node, yarn updates (#21) 2021-10-15 23:15:21 -04:00
.nvmrc build: node, yarn updates (#21) 2021-10-15 23:15:21 -04:00
.yarnrc.yml feat: initial proto 2021-07-13 22:45:47 -04:00
LICENSE Initial commit 2021-07-13 22:40:48 -04:00
netlify.toml feat: organize in feeds, sort by date (#12) 2021-07-25 14:18:16 -04:00
package.json build: node, yarn updates (#21) 2021-10-15 23:15:21 -04:00
README.md build: node, yarn updates (#21) 2021-10-15 23:15:21 -04:00
tsconfig.json refactor: react to preact (#15) 2021-08-02 01:26:24 -04:00
yarn.lock build: node, yarn updates (#21) 2021-10-15 23:15:21 -04:00

README.md

Yet Another RSS Reader (YARR) 🏴‍☠️

Overview

In a never-ending DIY quest, I've put together this RSS feed reader to keep up with the news. The main requirement observed here is to not require any sort of backend (except for a serverless proxy to get around CORS) and to keep it all as simple as possible.

The reader allows the user to provide RSS feed URLs that should be pulled, settings and fetched results are cached using browser local storage if it's available. The results caching is also used to prevent refetches on load if the cache is fresh enough.

The whole thing runs on Netlify's generous free tier.

Feel free to use it for your own RSS needs and to drop a word or two if you do. 🎉

Developping

. script/bootstrap will set up the correct version of Node (via nvm) as well as Yarn's vim SDK.

Once set up, yarn start will run the application locally (including a local instance of the Netlify function that handles CORS proxying).

Contributing

The project welcomes contributions as long as they fit within the general roadmap, which is still TBD. Any contribution making the bundle smaller will be eagerly reviewed and celebrated as long as it preserves functionality.