Hacking on hidden-hippo
Here's how to setup your development environment so that you can start hacking on hidden-hippo.
$ git clone git@github.com:beraboris/hidden-hippo
$ cd hidden-hippo
You have two options when it comes to the dev environment. You can use Vagrant, which is a magic VM thingy that sets up the whole environment for you. Or you can setup the environment yourself. Using Vagrant is the easier option.
If you don't already have it, install vagrant. You're also going to need either VMware or VirtualBox.
Setup the VM with: (This will create a VM with a working dev environment.)
$ vagrant up
Ssh into the VM with:
$ vagrant ssh
$ cd /vagrant
$ bundle install
Once you're done suspend the vm with:
$ vagrant suspend
In the VM, the code can be found in /vagrant
. This is a shared folder that is
automatically setup by vagrant.
Install ruby. We currently support:
- ruby 1.9.3
- ruby 2.0.0
- ruby 2.1.5
- ruby 2.2.0
Install bundler:
$ gem install bundler
Install dependencies
$ bundle install
Install mongodb. This is very platform specific. Look it up in the appropriate wiki. Currently we're only supporting
version 2.4. It could work with 2.6 but it's not tested. The unit tests assume that mongo is running on
localhost:27017
.
Install tshark. the tshark
executable needs to be somewhere in your $PATH
. tshark is part of the wireshark
distribution. It is sometimes packaged on its own.
Running hidden-hippo
$ bundle exec hh ...
$ rake
or
$ rspec spec/...