openstreetmap-website/VAGRANT.md
Matt Amos b460deaead Added some docs for Vagrant usage.
It doesn't currently recomment using Vagrant - there are probably
some bugs to work out in the process before we can do that.
2014-03-08 10:45:51 +00:00

1.1 KiB

Installing Vagrant

On Ubuntu, it should be as simple as:

sudo apt-get install vagrant

Other Linux distributions should have similar installation instructions using yum or similar.

Installers are available for Mac OS X and Windows, please see the Vagrant project download page for more information.

Setting up openstreetmap-website

Once Vagrant has been installed, you can start an environment by changing to the directory which contains the Vagrantfile and typing:

vagrant up

This will take a few minutes to download required software from the internet and set it up as a running system. Once it is complete, you should be able to log into the running VM by typing:

vagrant ssh

Within this login shell, you can do development, run the server or the tests. For example, to run the tests:

cd /srv/openstreetmap-website/
rake test

You should run the tests before submitting any patch or Pull Request back to the original repository. Please see CONTRIBUTING.md for more information.