https://github.com/cloudlena/rss-viewer

A static webpage to view any RSS feed
https://github.com/cloudlena/rss-viewer

rss rss-feed rss-reader solidjs static

Last synced: 10 days ago
JSON representation

A static webpage to view any RSS feed

• Host: GitHub
• URL: https://github.com/cloudlena/rss-viewer
• Owner: cloudlena
• License: gpl-3.0
• Created: 2024-06-04T20:33:43.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-10-15T18:32:24.000Z (about 1 month ago)
• Last Synced: 2024-10-17T03:44:26.264Z (30 days ago)
• Topics: rss, rss-feed, rss-reader, solidjs, static
• Language: TypeScript
• Homepage: https://cloudlena.github.io/rss-viewer/
• Size: 43.9 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# RSS Viewer

📺 A static webpage to view the weather and any RSS feed. This can be used on an E Ink display or small screen in your home (e.g., [Inklay](https://www.inklay.app/)).

**There is a [Demo](https://cloudlena.github.io/rss-viewer?location=Bern&feed=https%3A%2F%2Fwww.srf.ch%2Fnews%2Fbnf%2Frss%2F19032223) available.**

## Usage

You can either self-host RSS Viewer or use the deployed version at .

Open the app providing a `location` query string parameter for the weather and a `feed` one containing the URL-encoded URL of the RSS feed you want to view. E.g., `?feed=https%3A%2F%2Fwww.srf.ch%2Fnews%2Fbnf%2Frss%2F19032223` to view the feed at `https://www.srf.ch/news/bnf/rss/19032223`.

## Available Scripts

In the project directory, you can run:

### `npm run dev` or `npm start`

Runs the app in the development mode.


Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.


### `npm run build`

Builds the app for production to the `dist` folder.


It correctly bundles Solid in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.


Your app is ready to be deployed!

## Deployment

The viewer is deployed at  and can be used there for free.

To host your own instance, you can deploy the `dist` folder to any static host provider (GitHub Pages, Netlify, Surge, Now, etc.).