codeforleipzig/stadtratmonitor
codeforleipzig/stadtratmonitor
1
1
Fork 0
mirror of https://github.com/CodeforLeipzig/stadtratmonitor.git synced 2024-12-22 23:53:15 +01:00
Code Issues Projects Releases Packages 4 Wiki Activity

Update README.md

Browse source
This commit is contained in:
Andreas Haller 2015-05-19 09:59:43 +02:00
parent 7e6675ceab
commit 52c80956d2
1 changed files with 16 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -3,9 +3,22 @@
## Setup ## Setup
1. Install Ruby, Bundler, Elasticsearch 1. Install Ruby, Bundler, Elasticsearch
1. Start Elasticsearch: `$ elasticsearch` 1. Start Elasticsearch: `elasticsearch`
1. Setup Rails app: `$ bundle && bundle exec rake db:setup` 1. Setup Rails app: `bundle && bundle exec rake db:setup`
1. Start Rails server: `$ bundle exec rails s` 1. Start Rails server: `bundle exec rails s`
1. Visit [http://localhost:3000](http://localhost:3000) 1. Visit [http://localhost:3000](http://localhost:3000)
TODOs: https://github.com/ahx/stadtratmonitor/issues TODOs: https://github.com/ahx/stadtratmonitor/issues
## 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](https://morph.io/documentation/api?scraper=ahx%2Fcity_council_leipzig_recent_papers).
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:from_morph`.