2015-05-19 09:49:07 +02:00
# Stadtratmonitor
2016-04-12 21:07:20 +02:00
[](https://travis-ci.org/CodeforLeipzig/stadtratmonitor) [](https://coveralls.io/github/CodeforLeipzig/stadtratmonitor?branch=master) [](https://codeclimate.com/github/CodeforLeipzig/stadtratmonitor)
**Offical site:** https://stadtratmonitor.leipzig.codefor.de/
2016-03-26 14:39:27 +01:00
## 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
2016-03-26 15:32:45 +01:00
2016-03-26 14:39:27 +01:00
2016-03-26 15:32:45 +01:00
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
2016-03-26 15:32:45 +01:00
2016-03-26 14:39:27 +01:00
2016-03-26 15:32:45 +01:00
2016-03-26 14:39:27 +01:00
### Filtering
* By paper type
2016-03-26 15:32:45 +01:00
2016-03-26 14:39:27 +01:00
2016-03-26 15:32:45 +01:00
2016-03-26 14:39:27 +01:00
* By originator
2016-03-26 15:32:45 +01:00
2016-03-26 14:39:27 +01:00
2016-03-26 15:32:45 +01:00
2016-03-26 14:39:27 +01:00
### Staying up-to-date
2016-03-26 15:32:45 +01:00
#### General
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 )
2016-03-26 15:32:45 +01:00
* [Firefox RSS extension ](https://addons.mozilla.org/en-US/firefox/addon/rss-feed-icon-in-navbar/ )
2016-03-26 14:39:27 +01:00
* Reading
* [Google Chrome Extension ](https://chrome.google.com/webstore/detail/rss-feed-reader/pnjaodmkngahhkoihejjehlcdlnohgmp )
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
Copy the URL from the address bar
Create a new Feed in RSSOWL and paste the just copied URL in the form
2016-04-12 21:07:20 +02:00
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.
2016-03-26 14:39:27 +01:00
2015-05-19 09:49:07 +02:00
## Setup
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
2015-05-19 09:49:07 +02:00
1. Install Ruby, Bundler, Elasticsearch
2015-05-19 09:59:43 +02:00
1. Start Elasticsearch: `elasticsearch`
1. Setup Rails app: `bundle && bundle exec rake db:setup`
2016-03-02 21:38:57 +01:00
1. See "Importing data" below
2015-05-19 09:59:43 +02:00
1. Start Rails server: `bundle exec rails s`
2015-05-19 09:50:57 +02:00
1. Visit [http://localhost:3000 ](http://localhost:3000 )
2015-05-19 09:49:07 +02:00
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`
2016-03-02 21:38:57 +01:00
1. Initialize the database: `docker-compose run web rake db:setup`
1. See "Importing data" below
2016-01-23 20:33:08 +01:00
1. Get the address of the docker host: `docker-machine ip default`
2016-01-25 19:52:52 +01:00
1. Point your browser to: 'http://\<IP of docker host\>:3000'
2015-05-19 09:59:43 +02:00
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`
