https://github.com/avivace/rssnotifier
Node RSS reader telegram bot. Provides notification on queries-matching elements and supports multiple users.
https://github.com/avivace/rssnotifier
node notification-service notifications rss rss-aggregator rss-feed rss-feed-parser rss-feed-reader rss-reader telegram telegram-bot user-management
Last synced: 5 months ago
JSON representation
Node RSS reader telegram bot. Provides notification on queries-matching elements and supports multiple users.
- Host: GitHub
- URL: https://github.com/avivace/rssnotifier
- Owner: avivace
- License: gpl-3.0
- Created: 2017-05-14T16:26:34.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-04-12T19:01:56.000Z (over 5 years ago)
- Last Synced: 2025-05-06T19:13:06.540Z (5 months ago)
- Topics: node, notification-service, notifications, rss, rss-aggregator, rss-feed, rss-feed-parser, rss-feed-reader, rss-reader, telegram, telegram-bot, user-management
- Language: JavaScript
- Homepage:
- Size: 71.3 KB
- Stars: 16
- Watchers: 4
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RSSnotifier
> An RSS reader. On steroids.
Built by [Denni Bevilacqua](https://github.com/dennib) and [Antonio Vivace](https://github.com/avivace)
## Structure
#### `index.js`
A Node **backend** handles the feed parsing and reading. The `match` function flags specific elements, based on user-defined keywords (*queries*).
#### `bot.js`
A telegram bot - working as a frontend - allowing multiple users to define their subscriptions, preferences and *queries*.
Every subscription can be set on two modes:
- **query-mode** - every query-matching element triggers a notification;
- **reading-mode** - every new element will be notified.
## Usage
Given you have Node (and npm) installed, deploy your instance:
- Clone this repo, `git clone https://github.com/avivace/rssnotifier`
- Edit `config.js` with your botToken and configure the whitelisting
- `npm install`
- `npm start`
- Talk with the bot and add a sample query