stadtratmonitor/README.md
Lars Henrik Mai a3ac746ac0 Update README
2016-01-23 20:33:08 +01:00

1.2 KiB

Stadtratmonitor

Setup

  1. Install Ruby, Bundler, Elasticsearch
  2. Start Elasticsearch: elasticsearch
  3. Setup Rails app: bundle && bundle exec rake db:setup
  4. Start Rails server: bundle exec rails s
  5. 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. TODO db:migrate, import data, setup index
  4. Get the address of the docker host: docker-machine ip default
  5. Point your browser to: 'http://:3000'

Adding a data source (web scraper)

Example scraper: https://morph.io/ahx/city_council_leipzig_recent_papers

Scrapers are stored inside the database (see "Importer" model). To Add a new scraper, you have to create a new Importer record and set it's url field to Morph.io's API URL field.

Adding a scraper manually:

  1. Start Rails console bundle exec rails console
  2. Import.create(url: "https://api.morph.io/[scraper]/data.json?key=[api_key]&query=[sql]")
  3. exit

Now import everything via bundle exec rake import_papers.