https://github.com/mcataford/rss-reader

Yet Another RSS Reader :pirate_flag:
https://github.com/mcataford/rss-reader

hacktoberfest netlify rss rss-reader

Last synced: 5 days ago
JSON representation

Yet Another RSS Reader :pirate_flag:

• Host: GitHub
• URL: https://github.com/mcataford/rss-reader
• Owner: mcataford
• License: gpl-3.0
• Created: 2021-07-14T02:40:47.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-13T12:15:21.000Z (10 months ago)
• Last Synced: 2024-04-14T02:24:45.310Z (10 months ago)
• Topics: hacktoberfest, netlify, rss, rss-reader
• Language: TypeScript
• Homepage: https://rss-reader.karnov.club/
• Size: 5.22 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Yet Another RSS Reader (YARR) :pirate_flag:

> # ✈️ Moved away!

>

> This project has moved away from Github and is now hosted [elsewhere](https://forge.karnov.club/marc/rss-reader).

## 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](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) 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](https://www.netlify.com/)'s generous free tier.

Feel free to use it for your own RSS needs and to [drop a word or

two](https://github.com/mcataford/rss-reader/discussions/10) if you do. :tada:

## 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](https://testing-library.com/docs/react-testing-library/intro/).

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.