public-mirrors/NewsBlur-viq
1
0
Fork 0
mirror of https://github.com/viq/NewsBlur.git synced 2025-09-18 21:43:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
NewsBlur is a personal news reader that brings people together to talk about the world. A new sound of an old instrument.
1934 commits 2 branches 0 tags 863 MiB
CSS 68.9%
Objective-C 6.9%
Python 5.6%
HTML 5.1%
JavaScript 4.7%
Other 8.6%
Find a file
Samuel Clay 125eeb441f Linking all serverside and clientside technologies in README.
2011-07-17 11:34:38 -07:00
apps Adding attribution on favicon .ico handling. 2011-07-13 17:45:43 -07:00
config Adding development mongodb configuration file. 2011-06-09 19:00:48 -04:00
media Adding date to moderated recommended feeds to schedule recommendations. 2011-07-11 18:44:47 -07:00
templates Adding date to moderated recommended feeds to schedule recommendations. 2011-07-11 18:44:47 -07:00
utils Adding moderation queue to recommended feeds (finally!) 2011-07-11 18:22:28 -07:00
vendor Adding recovery parameter to OPML parser. 2011-06-10 11:14:29 -04:00
.gitignore Fixing logout button in iPhone app. 2010-11-15 19:40:17 -05:00
__init__.py Initial 2009-06-16 03:08:55 +00:00
fabfile.py Adding mac os x and linux installations instructions to README. 2011-07-17 11:31:07 -07:00
LICENSE.md Adding the MIT License and updating README. 2010-06-28 12:39:41 -04:00
local_settings.py.template Updating fabric file to fulfil the entire deployment of a new box with no hiccups. Still needs a hosts file, and maybe some envvars for hostname. 2011-03-15 10:02:13 -04:00
manage.py Initial 2009-06-16 03:08:55 +00:00
README.md Linking all serverside and clientside technologies in README. 2011-07-17 11:34:38 -07:00
requirements.txt Add gunicorn in requirements.txt. 2011-02-01 02:27:44 +01:00
settings.py Adding moderation queue to recommended feeds (finally!) 2011-07-11 18:22:28 -07:00
urls.py Adding in new mobile site. Doesn't sohwing anything but a stubbed in list view. 2011-06-05 17:52:11 -04:00

README.md

NewsBlur

Features

  1. Shows the original site (you have to see it to believe it)
  2. Hides stories you don't want to read based on tags, keywords, authors, etc.
  3. Highlights stories you want to read, based on the same criteria.

Technologies

Server-side

  • Django: Web framework written in Python, used to serve all pages.
  • Celery & RabbitMQ: Asynchronous queueing server, used to fetch and parse RSS feeds.
  • MongoDB, Pymongo, & Mongoengine: Non-relational database, used to store stories, read stories, feed/page fetch histories, and proxied sites.
  • PostgreSQL: Relational database, used to store feeds, subscriptions, and user accounts.

Client-side and design

  • jQuery: Cross-browser compliant JavaScript code. IE works without effort.
  • Underscore.js: Functional programming for JavaScript. Indispensible.
  • Miscellaneous jQuery Plugins: Everything from resizable layouts, to progress bars, sortables, date handling, colors, corners, JSON, animations. See the complete list.

Installation Instructions

Preface

Both Mac OS X and Linux require Fabric to be installed. Many common tasks, such as installing dependencies, deploying servers, migrations, and configurations are in fabfile.py.

sudo easy_install fabric

On recent installations of Mac OS X using XCode 4, you may run into issues around the ppc architecture. To fix this, simply run:

sudo ln -s /Developer/Platforms/iPhoneOS.platform/Developer/usr/libexec/gcc/darwin/ppc /Developer/usr/libexec/gcc/darwin
sudo ln -s /Developer/Platforms/iPhoneOS.platform/Developer/usr/libexec/gcc/darwin/ppc /usr/libexec/gcc/darwin

Sym-linking the ppc architecture comes from this StackOverflow answer on "assembler for architecture ppc not installed on Mac OS".

Mac OS X

Using Mac OS X as a development environment, you can run all three servers (app, db, task) on the same system. You should have Fabric installed to run the fabfile.py.

fab setup_python

Linux / Ubuntu

If you are on Ubuntu, you can simple use Fabric to install NewsBlur and its many components. NewsBlur is designed to run on three separate servers: an app server, a db server, and assorted task servers. To install everything on a single machine, read through fabfile.py and setup all three servers without repeating the setup_common steps.

App server

fab setup_app

Database server

fab setup_db

Task server

fab setup_task

Roadmap

Winter 2011

  • River of News
  • Starred stories

Summer 2011

  • iPhone app
  • Implicit sorting in River of News

Fall 2011

  • Social features

Author

License

NewsBlur is licensed under the MIT License. (See LICENSE)