Read Your News Faster.

Statuses

Description

Web-based RSS feed aggregator designed to shorten the time it takes to read articles by combining related articles into digestible chunks. It is similar to cir.ca, but it allows users to input their own sources and summarization is handled algorithmically.

Formerly hosted at http://sourcemash.com

The site was built for the CS98 course at Dartmouth College.

Installation

1. Clone repo to computer
2. Install postgresql (e.g. brew install postgresql)
3. Install redis (e.g. brew install redis)

4. Install all requirements from requirements.txt

   Virtual environment (preferred):

   1. Create a virtual environment: virtualenv flask
   2. Install requirements: flask/bin/pip install -r requirements.txt
   3. Activate virtual environment: . flask/bin/activate

   System-wide (not the best option): sudo pip install -r requirements.txt

Run Locally

1. Start up a local server: python manage.py server
2. In another terminal session, (optional)
   1. Start up a redis server: redis-server &
   2. Start up the background workers: python manage.py scrape_worker & python manage.py user_tasks_worker &
3. Start up the scraper: python manage.py scrape [--noqueue]

Tests

• To run the basic unittests, run python manage.py test.
• To include the functional tests, run python manage.py test --all or python manage.py test -a.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.