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 with more up-to-date installation instructions

Browse source
This commit is contained in:
Lars Henrik Mai 2016-03-02 21:38:57 +01:00
parent 06f5fc1bf5
commit 495d62ca61
1 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -1,10 +1,17 @@
# Stadtratmonitor # Stadtratmonitor
[![Build Status](https://travis-ci.org/CodeforLeipzig/stadtratmonitor.png?branch=master)](https://travis-ci.org/CodeforLeipzig/stadtratmonitor)
## Setup ## 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. 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. See "Importing data" below
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)
@ -12,21 +19,14 @@
1. Install docker and docker-compose: https://docs.docker.com/compose/install/ 1. Install docker and docker-compose: https://docs.docker.com/compose/install/
1. Start the app: `docker-compose up` 1. Start the app: `docker-compose up`
1. TODO db:migrate, import data, setup index 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. Get the address of the docker host: `docker-machine ip default`
1. Point your browser to: 'http://\<IP of docker host\>:3000' 1. Point your browser to: 'http://\<IP of docker host\>:3000'
## Adding a data source (web scraper) ### Importing data and building the index
Example scraper: https://morph.io/ahx/city_council_leipzig_recent_papers 1. Currently an API key for morph is required:
`cp config/morph.yml.example config/morph.yml`
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). 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`
Adding a scraper manually: 1. Build the elasticsearch index: `docker-compose run web rake index:rebuild`
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`.
[![Build Status](https://travis-ci.org/CodeforLeipzig/stadtratmonitor.png?branch=master)](https://travis-ci.org/CodeforLeipzig/stadtratmonitor)