README.md
[](http://travis-ci.org/holderdeord/hdo-site)
[](https://codeclimate.com/github/holderdeord/hdo-site)
[](https://gemnasium.com/holderdeord/hdo-site)
# IRC channel
Questions? Join us on [#holderdeord on irc.freenode.net](irc://irc.freenode.net/holderdeord)!
# Development environment
## ... on Debian/Ubuntu
Install package dependencies and set up Ruby 2.0.0 with RVM.
$ sudo apt-get install \
autoconf \
automake \
bison \
build-essential \
curl \
git-core \
imagemagick \
libc6-dev \
libpq-dev \
libreadline6 \
libreadline6-dev \
libsqlite3-dev \
libssl-dev \
libtool \
libxml2-dev \
libxslt-dev \
libyaml-dev \
ncurses-dev \
openssl \
postgresql \
postgresql-server-dev-9.1 \
wnorwegian \
zlib1g \
zlib1g-dev
$ curl -L get.rvm.io | bash -s stable --ruby
$ ruby -v
ruby 2.0.0p247 (2013-06-27 revision 41674) [x86_64-linux]
PS. For RVM to work properly with gnome-terminal, you have to tick the "Run command as login shell" checkbox on the "Title and Command" tab inside of gnome-terminal's Settings page.
### ElasticSearch
Follow the link to the latest stable release [here](http://www.elasticsearch.org/download/) and download the appropriate distribution. For apt, download the linked `.deb` and run:
$ sudo dpkg -i elasticsearch.deb
By default, elasticsearch may cluster with other nodes on the same network, which may cause problems. To avoid this, use a unique name for the `cluster.name` setting in `/etc/elasticsearch/elasticsearch.yml`.
### Database
To allow Rails to connect, edit /etc/postgresql/9.1/main/pg_hba.conf as root and change the line for Unix domain socket from "peer" to "trust":
# "local" is for Unix domain socket connections only
-local all all peer
+local all all trust
Then restart the database:
$ sudo su postgres -c "/etc/init.d/postgresql restart"
## ... on OS X
You'll need [XCode](https://developer.apple.com/xcode/) installed—including the Command Line Tools.
Since 10.9, the default Ruby on OS X is 2.0. If you're using an earlier version, install Ruby 2.0.0 through [RVM](http://rvm.io/):
$ curl -L https://get.rvm.io | bash -s stable --ruby
Install dependencies through [Homebrew](http://mxcl.github.com/homebrew/):
_This list may be incomplete. Please add any missing libs you find._
$ brew install git imagemagick elasticsearch
Follow the post-install instructions (`brew info elasticsearch`) on how to start ElasticSearch on login.
### Database
If you're on Lion or later, use [Postgres.app](http://postgresapp.com/):
* Download the app, drag it to /Applications and launch it.
* Set up your path to point to the command line tools as described [here](http://postgresapp.com/documentation).
Otherwise, use Homebrew to install PostgreSQL:
$ brew install postgresql
Follow brew's post-install instructions for PostgreSQL. Typically you want to run the `initdb`
and the launchtl ("load on login") commands.
Note: If you're on OS X >= 10.7 and get a connection error when preparing the database, try these steps:
* Run `echo $PATH | tr ':' '\n'` and make sure /usr/local/bin comes before /usr/bin.
* Open a new shell and try there.
* Check [this post](http://www.iainlbc.com/2011/10/osx-lion-postgres-could-not-connect-to-database-postgres-after-homebrew-installation/).
# Preparing the database:
Create the "hdo" user with the [createuser command](http://www.postgresql.org/docs/9.1/interactive/app-createuser.html):
$ sudo su - postgres # Only needed on Linux.
$ createuser hdo --no-superuser --no-createrole --createdb
If you used [Postgres.app](http://postgresapp.com/), make sure you've set up the [command line tools](http://postgresapp.com/documentation) correctly. Otherwise you'll be using the older PostgreSQL version that ships with OS X >= 10.7.
# Starting the application:
$ git clone git://github.com/holderdeord/hdo-site.git
$ cd hdo-site
$ gem install bundler
$ [sudo] bundle install
$ cp config/database.yml.example config/database.yml
$ rake db:setup
$ rails server puma
# Data
## Set up development data
Import a stripped DB dump, reindex and set up images:
$ rake import:dev:dump
$ rake search:setup search:reindex
$ rake images:reset
The last command will download representative images and associate party logos with the imported parties.
## Data model
To see an entity-relationship diagram of the database:
$ rake erd
# or
$ rake erd title="HDO Data Model"
This will generate `ERD.pdf`.
# Running specs:
To run all specs and buster.js tests:
$ rake spec:all
To run all Ruby specs:
$ rake spec
To run only JS tests:
$ rake spec:js
You can also run specific specs, i.e. model, controller or request specs with e.g.:
$ rake spec:models
Run specs with Rails preloaded
$ spin serve # separate shell
$ spin push spec
$ spin push spec/controllers
$ spin push spec/models/representative_spec.rb:10
# etc.
# JavaScript:
## Testing
We use [buster.js](http://busterjs.org/) for JavaScript testing.
To run the tests you need to have buster.js installed.
Buster.JS on the command-line requires Node 0.6.3 or newer and NPM.
Node 0.6.3 and newer comes with NPM bundled on most platforms.
Install buster and autolint:
$ npm install -g buster autolint
To run the tests once:
$ rake js:test
You can also run the buster server in the background and capture
your local browser:
$ buster server &
Then open [http://localhost:1111](localhost:1111) in your favorite browser.
To add more tests, update the config in spec/buster.js.
## Linting
$ npm install -g autolint
$ rake js:lint
or
$ cd spec && autolint
# Deployment
Our own servers are set up with Puppet, using the code from the [hdo-puppet repo](http://github.com/holderdeord/hdo-puppet).
## Docker
You can run the site using Docker + docker-compose:
$ mkdir -p docker-volumes/{pg,es,hdo-site}/data && chmod 0777 docker-volumes/{pg,es,hdo-site}/data
$ docker-compose up -d
$ docker-compose run --rm hdo-site bash -c 'bundle exec rake db:migrate'
$ docker-compose run --rm hdo-site bash -c 'bundle exec script/import parliament-periods'
$ docker-compose run --rm hdo-site bash -c 'bundle exec script/import parties'
Now you should be able to access the app at localhost:3333.