Yet Another RSS Reader 🏴‍☠️
Find a file
Marc Cataford 294e8d40a0
feat: api reorg (#118)
* feat: reorg into workspaces

* build: commands update

* ci: update build steps

* ci: publish from dist

* feat: api scaffold

* chore: clean up dist
2023-06-27 13:54:34 -04:00
.github/workflows feat: api reorg (#118) 2023-06-27 13:54:34 -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
packages feat: api reorg (#118) 2023-06-27 13:54:34 -04:00
script build: node@18, yarn + corepack (#117) 2023-06-27 12:00:44 -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 feat: api reorg (#118) 2023-06-27 13:54:34 -04:00
.nvmrc build: node@18, yarn + corepack (#117) 2023-06-27 12:00:44 -04:00
.yarnrc.yml build: node@18, yarn + corepack (#117) 2023-06-27 12:00:44 -04:00
LICENSE Initial commit 2021-07-13 22:40:48 -04:00
netlify.toml feat: api reorg (#118) 2023-06-27 13:54:34 -04:00
package.json feat: api reorg (#118) 2023-06-27 13:54:34 -04:00
README.md build: node, yarn updates (#21) 2021-10-15 23:15:21 -04:00
renovate.json chore: weekly scheduling for renovate (#75) 2022-09-03 14:52:47 -04:00
tsconfig.json refactor: move lots of logic to hooks, declutter (#22) 2022-03-13 10:19:00 -04:00
yarn.lock feat: api reorg (#118) 2023-06-27 13:54:34 -04:00

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.