codeforleipzig/stadtratmonitor
codeforleipzig/stadtratmonitor
1
1
Fork 0
mirror of https://github.com/CodeforLeipzig/stadtratmonitor.git synced 2024-12-22 15:43:14 +01:00
Code Issues Projects Releases Packages 4 Wiki Activity
Stadtratmonitor – Frontend https://stadtratmonitor.leipzig.codefor.de
135 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
Jörg Reichert 2139ccae04 Update README.md 
some usage documentation
2016-03-26 14:39:27 +01:00
app by default sort by published date, as initial web site shows all papers and thus there is no query yet that can be sorted by relevance 2016-03-26 13:40:39 +01:00
bin Update spring gem 2016-03-02 21:06:26 +01:00
config Flush stdout immediately in development in order to get realtime log output in docker 2016-03-05 11:41:04 +01:00
db Add paper_searches table 2015-11-23 22:10:45 +01:00
lib added .coveralls.yml file 2016-03-05 21:24:04 +01: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 use coveralls only in spec 2016-03-05 22:04:05 +01:00
test Login button entfernt 2016-03-26 10:00:04 +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 .vagrant dir 2016-01-23 20:31:40 +01: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
.ruby-version Start with a Rails app with authentication via Persona, Foundation CSS 2014-11-19 18:48:28 +01:00
.travis.yml add env variables when running rspec 2016-03-05 23:24:36 +01:00
config.ru Start with a Rails app with authentication via Persona, Foundation CSS 2014-11-19 18:48:28 +01:00
docker-compose.yml add env variables when running rspec 2016-03-05 23:24:36 +01:00
Dockerfile Add Dockerfile and docker-compose config 2016-01-23 20:33:02 +01:00
Gemfile added coveralls 2016-03-05 19:26:31 +01:00
Gemfile.lock added badges and lock file 2016-03-05 20:19:56 +01:00
Guardfile Add guard file watcher 2016-02-18 08:41:45 +01:00
LICENSE Initial commit 2014-11-19 17:03:06 +01:00
Rakefile Start with a Rails app with authentication via Persona, Foundation CSS 2014-11-19 18:48:28 +01:00
README.md Update README.md 2016-03-26 14:39:27 +01:00

README.md

Stadtratmonitor

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

Build Status Coverage Status Code Climate

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