mirror of
https://github.com/CodeforLeipzig/stadtratmonitor.git
synced 2025-04-09 03:26:43 +02:00
84 lines
3.9 KiB
Markdown
84 lines
3.9 KiB
Markdown
# Stadtratmonitor
|
|
|
|
[](https://travis-ci.org/CodeforLeipzig/stadtratmonitor) [](https://coveralls.io/github/CodeforLeipzig/stadtratmonitor?branch=master)
|
|
|
|
**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
|
|
|
|
|
|
|
|
* Sort by relevance, e.g. how often the search keyword appears inside the title resp. the content of the paper
|
|
|
|
|
|
|
|
### Filtering
|
|
* By paper type
|
|
|
|
|
|
|
|
* By originator
|
|
|
|
|
|
|
|
### 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
|
|
|
|
|
|
Copy the URL from the address bar
|
|
|
|
|
|
Create a new Feed in RSSOWL and paste the just copied URL in the form
|
|
|
|
|
|
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`
|