README

Feedreader is a simple Django app to aggregate RSS feeds.

Features

• Locally stored feed link, title and description.
• Locally stored entry link, title and description.
• Show recent entries.
• String search of locally stored data.
• Uses Django admin to manage feeds.

Detailed documentation is in the "docs" directory. These are available online here.

Quick start

1. Add "feedreader" to your INSTALLED_APPS setting like this:

   INSTALLED_APPS = (...
                     'feedreader',
                     )

2. Include the feedreader URLconf in your project urls.py like this:

   path('feedreader/', include('feedreader.urls')),

3. Run python manage.py migrate to create the feedreader models.
4. Run python manage.py collectstatic to copy static files to your project's static root.
5. Start the development server and visit /admin/feedreader/feed/ to add feeds. Only each feed's xml url is needed.
6. Visit /feedreader/ to see the contents of the feeds.

Dependencies

• Django 2.2.3
• django-braces 1.13.0
• factory_boy 2.12.0
• feedparser 5.2.1