|
|
||
|---|---|---|
| .github/workflows | ||
| assets | ||
| functions/rss-proxy | ||
| script | ||
| src | ||
| .gitattributes | ||
| .gitignore | ||
| .nvmrc | ||
| .yarnrc.yml | ||
| biome.json | ||
| LICENSE | ||
| netlify.toml | ||
| package.json | ||
| README.md | ||
| renovate.json | ||
| testSetup.ts | ||
| tsconfig.json | ||
| vite.config.js | ||
| yarn.lock | ||
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).
Testing
Frontend component tests are written using React Testing Library.
Rendering components should be done via the testHelpers/renderUtils exports, which provides a renderComponent helper
that wraps the component in all the contexts provided to the application. This also sets up
@testing-library/user-events.
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.