stadtratmonitor/README.md

# Stadtratmonitor

[![Build Status](https://travis-ci.org/CodeforLeipzig/stadtratmonitor.png?branch=master)](https://travis-ci.org/CodeforLeipzig/stadtratmonitor) [![Coverage Status](https://coveralls.io/repos/github/CodeforLeipzig/stadtratmonitor/badge.svg?branch=master)](https://coveralls.io/github/CodeforLeipzig/stadtratmonitor?branch=master) [![Code Climate](https://codeclimate.com/github/CodeforLeipzig/stadtratmonitor/badges/gpa.svg)](https://codeclimate.com/github/CodeforLeipzig/stadtratmonitor)
[![Dependency Status](https://gemnasium.com/badges/github.com/CodeforLeipzig/stadtratmonitor.svg)](https://gemnasium.com/github.com/CodeforLeipzig/stadtratmonitor)


**Offical site:** https://stadtratmonitor.leipzig.codefor.de/

## Usage / Features

The Stadtratmonitor Leipzig is a lightweight user interface for performing full text searches against paper contents issued to the city council of Leipzig. Note, this solution uses the data from [Ratsinformationssystem Leipzig](https://ratsinfo.leipzig.de/bi/allris.net.asp) that also offers [text search capabilities](https://ratsinfo.leipzig.de/bi/yw010.asp).

### Sorting
 * Sort by date, paper was issued

![Papers sorted by publishing date](https://cloud.githubusercontent.com/assets/994131/14060246/b29c0356-f35e-11e5-837a-2106dd274694.JPG)

 * Sort by relevance, e.g. how often the search keyword appears inside the title resp. the content of the paper

![Papers sorted by relevance](https://cloud.githubusercontent.com/assets/994131/14060257/f7491002-f35e-11e5-9d39-f36b81c35c33.JPG)

### Filtering
 * By paper type

![Filter by paper type](https://cloud.githubusercontent.com/assets/994131/14060263/28c9d800-f35f-11e5-8c56-e8d208d85916.JPG)

 * By originator

![Filter by originator](https://cloud.githubusercontent.com/assets/994131/14060267/4fa539a6-f35f-11e5-981e-2467daf2dee2.JPG)

### Staying up-to-date
#### General
 * Subscribing
  * [Google Chrome RSS extension](https://chrome.google.com/webstore/detail/rss-subscription-extensio/nlbjncdgjeocebhnmkbbbdekmmmcbfjd?hl=de)
  * [Firefox RSS extension](https://addons.mozilla.org/en-US/firefox/addon/rss-feed-icon-in-navbar/)
 * Reading
  * [Google Chrome Extension](https://chrome.google.com/webstore/detail/rss-feed-reader/pnjaodmkngahhkoihejjehlcdlnohgmp)
  * [Firefox Extension](https://addons.mozilla.org/en-US/firefox/addon/simple-rss-reader-srr)
  * [RSSOWL](http://www.rssowl.org/)

#### Example using Firefox and RSSOWL   
Click on the newsfeed icon in the address bar
![Abonnieren mit Firefox](https://cloud.githubusercontent.com/assets/994131/14060508/fe7f4514-f366-11e5-85ae-2fa2e50b91ea.JPG)

Copy the URL from the address bar
![RSS URL in Firefox](https://cloud.githubusercontent.com/assets/994131/14060515/30140e98-f367-11e5-9c77-86ba626e3c1b.JPG)

Create a new Feed in RSSOWL and paste the just copied URL in the form
![RSSOWL Feed](https://cloud.githubusercontent.com/assets/8532690/14472067/bbc5a64e-00f1-11e6-8e3e-551067b508e3.png)

When updating the feed in RSSOWL (or any other RSS reader of your choice) time after time all new papers matching the search query criteria will appear.

## Setup

There are two ways to run this app: using a local development setup, or using
docker.

### Local machine setup
1. Install Ruby, Bundler, Elasticsearch
1. Start Elasticsearch: `elasticsearch`
1. Setup Rails app: `bundle && bundle exec rake db:setup`
1. See "Importing data" below
1. Start Rails server: `bundle exec rails s`
1. Visit [http://localhost:3000](http://localhost:3000)

### Using docker

1. Install docker and docker-compose: https://docs.docker.com/compose/install/
1. Start the app: `docker-compose up`
1. Initialize the database: `docker-compose run web rake db:setup`
1. See "Importing data" below
1. Get the address of the docker host: `docker-machine ip default`
1. Point your browser to: 'http://\<IP of docker host\>:3000'

### Importing data and building the index
1. Currently an API key for morph is required:
   `cp config/morph.yml.example config/morph.yml`
   Edit the morph.yml file and insert the Morph API key
1. Import the data from our scraper: `docker-compose run web rake import_papers`
1. Build the elasticsearch index: `docker-compose run web rake index:rebuild`

### Running tests

Assuming docker and docker-compose is installed:

1. `docker-compose run web bin/run-tests`
Update and rename README.rdoc to README.md 2015-05-19 09:49:07 +02:00			`# Stadtratmonitor`

Update RSS screenshot, reordered site elements 2016-04-12 21:07:20 +02:00			`[![Build Status](https://travis-ci.org/CodeforLeipzig/stadtratmonitor.png?branch=master)](https://travis-ci.org/CodeforLeipzig/stadtratmonitor) [![Coverage Status](https://coveralls.io/repos/github/CodeforLeipzig/stadtratmonitor/badge.svg?branch=master)](https://coveralls.io/github/CodeforLeipzig/stadtratmonitor?branch=master) [![Code Climate](https://codeclimate.com/github/CodeforLeipzig/stadtratmonitor/badges/gpa.svg)](https://codeclimate.com/github/CodeforLeipzig/stadtratmonitor)`
Add Gemnasium badge to README 2016-05-04 23:12:50 +02:00			`[![Dependency Status](https://gemnasium.com/badges/github.com/CodeforLeipzig/stadtratmonitor.svg)](https://gemnasium.com/github.com/CodeforLeipzig/stadtratmonitor)`

Update RSS screenshot, reordered site elements 2016-04-12 21:07:20 +02:00
			`Offical site: https://stadtratmonitor.leipzig.codefor.de/`

Update README.md some usage documentation 2016-03-26 14:39:27 +01:00			`## Usage / Features`

Update travis config to use run-tests script And the README as well for good measure. 2016-05-04 22:41:45 +02:00			`The Stadtratmonitor Leipzig is a lightweight user interface for performing full text searches against paper contents issued to the city council of Leipzig. Note, this solution uses the data from [Ratsinformationssystem Leipzig](https://ratsinfo.leipzig.de/bi/allris.net.asp) that also offers [text search capabilities](https://ratsinfo.leipzig.de/bi/yw010.asp).`
Update README.md some usage documentation 2016-03-26 14:39:27 +01:00
			`### Sorting`
			`* Sort by date, paper was issued`
Update travis config to use run-tests script And the README as well for good measure. 2016-05-04 22:41:45 +02:00
Update README.md some usage documentation 2016-03-26 14:39:27 +01:00			`![Papers sorted by publishing date](https://cloud.githubusercontent.com/assets/994131/14060246/b29c0356-f35e-11e5-837a-2106dd274694.JPG)`
Update README.md added RSSOWL example 2016-03-26 15:32:45 +01:00
Update README.md some usage documentation 2016-03-26 14:39:27 +01:00			`* Sort by relevance, e.g. how often the search keyword appears inside the title resp. the content of the paper`
Update travis config to use run-tests script And the README as well for good measure. 2016-05-04 22:41:45 +02:00
Update README.md some usage documentation 2016-03-26 14:39:27 +01:00			`![Papers sorted by relevance](https://cloud.githubusercontent.com/assets/994131/14060257/f7491002-f35e-11e5-9d39-f36b81c35c33.JPG)`
Update README.md added RSSOWL example 2016-03-26 15:32:45 +01:00
Update README.md some usage documentation 2016-03-26 14:39:27 +01:00			`### Filtering`
			`* By paper type`
Update travis config to use run-tests script And the README as well for good measure. 2016-05-04 22:41:45 +02:00
Update README.md some usage documentation 2016-03-26 14:39:27 +01:00			`![Filter by paper type](https://cloud.githubusercontent.com/assets/994131/14060263/28c9d800-f35f-11e5-8c56-e8d208d85916.JPG)`
Update README.md added RSSOWL example 2016-03-26 15:32:45 +01:00
Update README.md some usage documentation 2016-03-26 14:39:27 +01:00			`* By originator`
Update travis config to use run-tests script And the README as well for good measure. 2016-05-04 22:41:45 +02:00
Update README.md some usage documentation 2016-03-26 14:39:27 +01:00			`![Filter by originator](https://cloud.githubusercontent.com/assets/994131/14060267/4fa539a6-f35f-11e5-981e-2467daf2dee2.JPG)`
Update README.md added RSSOWL example 2016-03-26 15:32:45 +01:00
Update README.md some usage documentation 2016-03-26 14:39:27 +01:00			`### Staying up-to-date`
Update README.md added RSSOWL example 2016-03-26 15:32:45 +01:00			`#### General`
Update README.md some usage documentation 2016-03-26 14:39:27 +01:00			`* Subscribing`
			`* [Google Chrome RSS extension](https://chrome.google.com/webstore/detail/rss-subscription-extensio/nlbjncdgjeocebhnmkbbbdekmmmcbfjd?hl=de)`
Update README.md added RSSOWL example 2016-03-26 15:32:45 +01:00			`* [Firefox RSS extension](https://addons.mozilla.org/en-US/firefox/addon/rss-feed-icon-in-navbar/)`
Update README.md some usage documentation 2016-03-26 14:39:27 +01:00			`* Reading`
			`* [Google Chrome Extension](https://chrome.google.com/webstore/detail/rss-feed-reader/pnjaodmkngahhkoihejjehlcdlnohgmp)`
Update README.md added RSSOWL example 2016-03-26 15:32:45 +01:00			`* [Firefox Extension](https://addons.mozilla.org/en-US/firefox/addon/simple-rss-reader-srr)`
			`* [RSSOWL](http://www.rssowl.org/)`

			`#### Example using Firefox and RSSOWL`
			`Click on the newsfeed icon in the address bar`
Update travis config to use run-tests script And the README as well for good measure. 2016-05-04 22:41:45 +02:00			`![Abonnieren mit Firefox](https://cloud.githubusercontent.com/assets/994131/14060508/fe7f4514-f366-11e5-85ae-2fa2e50b91ea.JPG)`
Update README.md added RSSOWL example 2016-03-26 15:32:45 +01:00
			`Copy the URL from the address bar`
			`![RSS URL in Firefox](https://cloud.githubusercontent.com/assets/994131/14060515/30140e98-f367-11e5-9c77-86ba626e3c1b.JPG)`

			`Create a new Feed in RSSOWL and paste the just copied URL in the form`
Update RSS screenshot, reordered site elements 2016-04-12 21:07:20 +02:00			`![RSSOWL Feed](https://cloud.githubusercontent.com/assets/8532690/14472067/bbc5a64e-00f1-11e6-8e3e-551067b508e3.png)`
Update README.md added RSSOWL example 2016-03-26 15:32:45 +01:00
			`When updating the feed in RSSOWL (or any other RSS reader of your choice) time after time all new papers matching the search query criteria will appear.`
Update README.md some usage documentation 2016-03-26 14:39:27 +01:00
Update and rename README.rdoc to README.md 2015-05-19 09:49:07 +02:00			`## Setup`

Update README with more up-to-date installation instructions 2016-03-02 21:38:57 +01:00			`There are two ways to run this app: using a local development setup, or using`
			`docker.`

			`### Local machine setup`
Update and rename README.rdoc to README.md 2015-05-19 09:49:07 +02:00			`1. Install Ruby, Bundler, Elasticsearch`
Update README.md 2015-05-19 09:59:43 +02:00			1. Start Elasticsearch: `elasticsearch`
			1. Setup Rails app: `bundle && bundle exec rake db:setup`
Update README with more up-to-date installation instructions 2016-03-02 21:38:57 +01:00			`1. See "Importing data" below`
Update README.md 2015-05-19 09:59:43 +02:00			1. Start Rails server: `bundle exec rails s`
Update README.md 2015-05-19 09:50:57 +02:00			`1. Visit [http://localhost:3000](http://localhost:3000)`
Update and rename README.rdoc to README.md 2015-05-19 09:49:07 +02:00
Update README 2016-01-23 20:33:08 +01:00			`### Using docker`

			`1. Install docker and docker-compose: https://docs.docker.com/compose/install/`
			1. Start the app: `docker-compose up`
Update README with more up-to-date installation instructions 2016-03-02 21:38:57 +01:00			1. Initialize the database: `docker-compose run web rake db:setup`
			`1. See "Importing data" below`
Update README 2016-01-23 20:33:08 +01:00			1. Get the address of the docker host: `docker-machine ip default`
Fix link address of dockerhost in README 2016-01-25 19:52:52 +01:00			`1. Point your browser to: 'http://\<IP of docker host\>:3000'`
Update README.md 2015-05-19 09:59:43 +02:00
Update README with more up-to-date installation instructions 2016-03-02 21:38:57 +01:00			`### Importing data and building the index`
			`1. Currently an API key for morph is required:`
			`cp config/morph.yml.example config/morph.yml`
			`Edit the morph.yml file and insert the Morph API key`
			1. Import the data from our scraper: `docker-compose run web rake import_papers`
			1. Build the elasticsearch index: `docker-compose run web rake index:rebuild`
Update travis config to use run-tests script And the README as well for good measure. 2016-05-04 22:41:45 +02:00
			`### Running tests`

			`Assuming docker and docker-compose is installed:`

			1. `docker-compose run web bin/run-tests`