Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/georapbox/rss-feed-reader
A simple RSS Feed Reader based on web technologies (HTML, CSS, JavaScript)
https://github.com/georapbox/rss-feed-reader
feed reader rss
Last synced: 7 days ago
JSON representation
A simple RSS Feed Reader based on web technologies (HTML, CSS, JavaScript)
- Host: GitHub
- URL: https://github.com/georapbox/rss-feed-reader
- Owner: georapbox
- License: mit
- Created: 2022-06-08T06:13:02.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-17T07:13:14.000Z (4 months ago)
- Last Synced: 2024-10-05T12:59:40.942Z (about 1 month ago)
- Topics: feed, reader, rss
- Language: JavaScript
- Homepage: https://georapbox.github.io/rss-feed-reader/
- Size: 9.6 MB
- Stars: 8
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RSS Feed Reader
A Progressive Web App (PWA) for reading RSS feeds.
## About
RSS Feed Reader is a web application that allows you to read RSS feeds in a clean and simple interface. It is built using Web components and is a Progressive Web App (PWA) which means it can be installed on your device and used offline.
## Live demo
👉 [RSS Feed Reader](https://georapbox.github.io/rss-feed-reader/)
## Features
Some of the key features of the application include:
- Add one or many RSS feeds in XML format.
- Enable/disable feeds per will.
- Export/share feeds URLs to use in other devices (all data is saved on device).
## Screenshots
The following screenshots show the application in action:
## Development
Below are the instructions for setting up the development environment.
### Prerequisites
- Node.js (v20.x.x)
- npm (v10.x.x)
### Installation
Clone the repository to your local machine:
```sh
git clone [email protected]:georapbox/rss-feed-reader.git
```
Navigate to the project's directory and install the dependencies:
```sh
npm install
```
### Running the application
To run the application in development mode, run the following command:
```sh
npm start -- --open
```
This will start the development server and open the application in your default web browser.
### Building the application for production
To build the application for production, run the following command:
```sh
npm run build
```
This will create a `dist` directory containing the production build of the application.
### Deployment
To deploy the application, run the following command:
```sh
npm run deploy
```
This will build the application first and then deploy it to GitHub Pages in the `gh-pages` branch.
## Helpful links
- [RSS feeds collection](https://github.com/simevidas/web-dev-feeds) for web developers by [@simevidas](https://github.com/simevidas).
- [Get RSS Feed URL](https://addons.mozilla.org/en-US/firefox/addon/get-rss-feed-url/) Firefox addon
- [Get RSS Feed URL](https://chrome.google.com/webstore/detail/get-rss-feed-url/kfghpdldaipanmkhfpdcjglncmilendn) Chrome extension
## License
[The MIT License (MIT)](https://github.com/georapbox/rss-feed-reader/blob/main/LICENSE)