Skip to content

georapbox/rss-feed-reader

Repository files navigation

RSS Feed Reader

RSS Feed Reader

A simple RSS Feed Reader based on web technologies (HTML, CSS, JavaScript)

Demo

Features

  • 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).

Technologies used

  • RSS 2 JSON API (used to convert feeds from XML to JSON format)
  • Custom Elements aka Web components
  • Progressive Web App (PWA)

Screenshots

Screenshot lightScreenshot dark

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:

git clone git@github.com:georapbox/rss-feed-reader.git

Navigate to the project's directory and install the dependencies:

npm install

Running the application

To run the application in development mode, run the following command:

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:

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:

npm run deploy

This will build the application first and then deploy it to GitHub Pages in the gh-pages branch.

Helpful links

License

The MIT License (MIT)

About

A simple RSS Feed Reader based on web technologies (HTML, CSS, JavaScript)

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published