Skip to content

JulienArnold/consum-rss-trawler

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

61 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Article Hunter (consum-rss-trawler)

A small web application that accepts keywords and RSS feeds (as URLs) and parses through searching for the given keywords and displays a list of links to relevant posts from any given feed/s.

Quick Tutorial

  1. Fork/git clone this repository.
  2. Ensure the relevant module dependencies have been installed. These can be viewed under the dependencies nest within package.json, and installed via npm install modulename.
  3. To launch the app, type node fp.js from within the command line.
  4. A server will begin listening on localhost:3000, with more information on the home page/index.html.
  5. The app requires at least one keyword and feed to function.

5.i. To add keywords and feeds to be parsed through, paste a valid URL directly to the Atom/RSS/XML feed you wish to be parsed in the "Feeds" textbox, and click the Add button alongside. This can be done multiple times.

5.ii. Repeat with the keywords textbox, adding one word at a time.

  1. When you are satisfied with what you wish to be parsed, click the Start button. This will send the feeds and keywords as parameters to be used. Check the command line for more information while this is running.
  2. To view the results, navigate in your browser to localhost:3000.

7.i. Automatic results are scheduled to run at 9am daily, and are updated/posted to /nightly. The home page provides a link.

7.ii. Trending results (alpha) are accumulated alongside both manual and automatic runs to /trends. The home page also provides a link.

Note: The app is case-sensitive with keywords; results may vary based on this fact.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published