codeforleipzig/stadtratmonitor
codeforleipzig/stadtratmonitor
1
1
Fork 0
mirror of https://github.com/CodeforLeipzig/stadtratmonitor.git synced 2024-12-22 07:43:13 +01:00
Code Issues Projects Releases Packages 4 Wiki Activity
Stadtratmonitor – Frontend https://stadtratmonitor.leipzig.codefor.de
245 commits 9 branches 0 tags 4 MiB
JavaScript 53.6%
CSS 37.5%
Ruby 4.7%
SCSS 1.9%
Slim 1.8%
Other 0.5%
Find a file
Joerg Reichert cbf986c477 Update 2023
2023-03-29 21:02:52 +02:00
.vscode Update 2023 2023-03-29 21:02:52 +02:00
app Use data originated from OParl API 2020-09-20 23:18:17 +02:00
bin Add dockerize to wait for elasticsearch to boot during test runs 2020-01-16 12:56:35 +01:00
config Fix a bunch of rubocop offenses 2020-03-11 14:29:50 +01:00
db Fix a bunch of rubocop offenses 2020-03-11 14:29:50 +01:00
docker/elasticsearch Update 2023 2023-03-29 21:02:52 +02:00
lib Use data originated from OParl API 2020-09-20 23:18:17 +02:00
log Start with a Rails app with authentication via Persona, Foundation CSS 2014-11-19 18:48:28 +01:00
public Start with a Rails app with authentication via Persona, Foundation CSS 2014-11-19 18:48:28 +01:00
spec Fix a bunch of rubocop offenses 2020-03-11 14:29:50 +01:00
vendor/assets Start with a Rails app with authentication via Persona, Foundation CSS 2014-11-19 18:48:28 +01:00
.coveralls.yml readded after_success call 2016-03-05 21:54:04 +01:00
.dockerignore Add Dockerfile and docker-compose config 2016-01-23 20:33:02 +01:00
.gitignore gitignore node_modules 2016-05-04 20:56:57 +02:00
.project added .travis.yml 2016-03-02 20:05:12 +01:00
.rspec add rspec config 2016-02-17 07:58:57 +01:00
.rubocop.yml Fix a bunch of rubocop offenses 2020-03-11 14:29:50 +01:00
.rubocop_todo.yml Fix a bunch of rubocop offenses 2020-03-11 14:29:50 +01:00
.ruby-version fix travis build 2020-01-15 22:34:27 +01:00
.travis.yml fix travis build 2020-01-15 22:34:27 +01:00
config.ru Fix a bunch of rubocop offenses 2020-03-11 14:29:50 +01:00
docker-compose.yml Update elasticsearch 2020-01-16 12:20:47 +01:00
docker-entrypoint.sh fix finally server pid issue at docker container restart 2019-04-14 23:52:36 +02:00
Dockerfile Update 2023 2023-03-29 21:02:52 +02:00
Gemfile Update 2023 2023-03-29 21:02:52 +02:00
Gemfile.lock Update 2023 2023-03-29 21:02:52 +02:00
Guardfile Fix a bunch of rubocop offenses 2020-03-11 14:29:50 +01:00
LICENSE Initial commit 2014-11-19 17:03:06 +01:00
Rakefile Fix a bunch of rubocop offenses 2020-03-11 14:29:50 +01:00
README.md Fix search bug 2019-10-27 14:34:49 +01:00

README.md

Stadtratmonitor

Build Status Coverage Status

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 that also offers text search capabilities.

Sorting

  • Sort by date, paper was issued

Papers sorted by publishing date

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

Papers sorted by relevance

Filtering

  • By paper type

Filter by paper type

  • By originator

Filter by originator

Staying up-to-date

General

Example using Firefox and RSSOWL

Click on the newsfeed icon in the address bar Abonnieren mit Firefox

Copy the URL from the address bar RSS URL in Firefox

Create a new Feed in RSSOWL and paste the just copied URL in the form RSSOWL Feed

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
  2. Start Elasticsearch: elasticsearch
  3. Setup Rails app: bundle && bundle exec rake db:setup
  4. See "Importing data" below
  5. Start Rails server: bundle exec rails s
  6. Visit http://localhost:3000

Using docker

  1. Install docker and docker-compose: https://docs.docker.com/compose/install/
  2. Start the app: docker-compose up
  3. Initialize the database: docker-compose run web rake db:setup
  4. See "Importing data" below
  5. Get the address of the docker host: docker-machine ip default
  6. 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
  2. Import the data from our scraper: docker-compose run web rake import_papers
  3. 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