Unleash awesomeness. Private packages, team management tools, and powerful integrations. Get started with npm Orgs »

bird-feeder

1.1.0-beta • Public • Published

bird-feeder

Stability npm version JavaScript Style Guide Build Status Coverage Status Greenkeeper badge

An extremely basic self-hosted RSS reader.

Given an array of feed URLs, it collects the 20 most recent entries from each and concatenates them in order of publish date. It then renders some information about them in a static front page. By default, it reloads articles on each page load.

Install

Download the source using git and install dependencies using npm:

$ git clone garbados/bird-feeder
cd bird-feeder
$ npm install

Now edit config.json to contain the feed URLs you want to follow:

$ nano config.json
{
    "feedUrls": [
        "http://feeds.arstechnica.com/arstechnica/index",
        "https://garbados.github.io/my-blog/rss.xml"
    ]
}

Now start the server:

$ npm start
Now listening on port 3000

You can also add the bird-feeder command to your $PATH with npm:

$ npm link
$ bird-feeder -h
 
bird-feeder
 
Start the feed server
 
Commands:
  bin.js start  Start the feed server                 [default] [aliases: serve]
 
Options:
  --version   Show version number                                      [boolean]
  --port, -p  Port for the server to listen on.                  [default: 3000]
  -h, --help  Show help                                                [boolean]

Test

After installing dependencies, run the test suite with npm:

$ npm install
$ npm test

Here's a one-liner for checking test coverage:

$ npx nyc npm test

Contributing

To report bugs or request features, file an issue. If you want to merge code, file a pull request. I reserve sole discretion for the moderation of this project.

License

Apache-2.0

Keywords

install

npm i bird-feeder

Downloadsweekly downloads

2

version

1.1.0-beta

license

Apache-2.0

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability