sl2/HackerNewsRecorder

A simple Hacker News Recorder and Reader

Hacker News Recorder

A simple Hacker News Recorder & Reader for analytics.

Environment

You can deploy this application following two environments.

1. local server, IaaS
2. heroku
   • MongoHQ is required
   • Only Web Dyno x1 is required. So you can use free plan.

Requirements

• Python 2.7.x
  • Bottle
  • PyMongo
  • karan / HackerNewsAPI
• MongoDB or MongoHQ (if you use heroku)

Installation : Local server, IaaS

1. Download the repositry

    git clone https://github.com/sodesign/HackerNewsRecorder.git
   

2. Install required Python packages

    pip install bottle
    pip install pymongo
    pip install HackerNews==1.7.2
   

3. Start a MongoDB

4. Start the application

    python app.py
   

Installation : heroku

1. Download the repositry

    git clone https://github.com/sodesign/HackerNewsRecorder.git
   

2. Deploy to heroku

    cd HackerNewsRecorder
    heroku apps:create [app name]
    git push heroku master
   

3. Add MongoHQ via heroku dashboard

4. Restart the application heroku restart --app [app name]

Usage

1. Download new entries from Hacker News to MongoDB

   • http://APPURL/update/<collection_name>/<page_num>

     • <collection_name> : top, newest, best

     • <page_nume> : 1, ... ,10

   It is recommended to use "crond" and "wget --spider" commands for automatic updates.

2. Read entries from MongoDB

   • top: http://APPURL or http://APPURL/top

   • best: http://APPURL/best

   • newest: http://APPURL/newest

ToDo

1. Add analytics
2. Improve reader
3. Improve database update method (current method is not so good)

License

• MIT License