https://github.com/cfpb/collab-news

https://github.com/cfpb/collab-news

Last synced: 17 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/cfpb/collab-news
• Owner: cfpb
• License: other
• Created: 2014-01-16T15:20:58.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2020-05-15T13:45:22.000Z (over 4 years ago)
• Last Synced: 2024-04-08T00:16:53.158Z (9 months ago)
• Language: Python
• Size: 128 KB
• Stars: 8
• Watchers: 9
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: COPYING.txt

Awesome Lists containing this project

README

        
# News

[![Build Status](https://travis-ci.org/cfpb/collab-news.svg?branch=master)](https://travis-ci.org/cfpb/collab-news)

*News* is a [Collab](https://github.com/cfpb/collab) application to show articles in a blog like format to the application users.

The articles can be categorized in feeds or rendered on the main page.

## Pages

News has different views:

* Index page with all articles

* Feed page (only that feed's articles)

* Article detail

## Screenshot

![index page](screenshots/main.png "Index Page")

## Installation

To use this application you will need to first have [Collab](https://github.com/cfpb/collab) installed.

Then, once you clone this repo, you can install the application using setuptools:

`python setup.py install`

Or, if you are developing with this app, you can add it to your search path like:

```

cd collab

ln -s ../collab-news/news .

```

Once the application is installed, add it to core collab's `INSTALLED_APPS` in your `local_settings.py` file:

```

INSTALLED_APPS += ( 'news', )

```

## Contributing

Please read the [contributing guide](./CONTRIBUTING.md).