VAGRANT.md

   1 # Installing Vagrant
   2
   3 On Ubuntu, it should be as simple as:
   4
   5 ```
   6 sudo apt-get install vagrant
   7 ```
   8
   9 Other Linux distributions should have similar installation instructions using `yum` or similar.
  10
  11 Installers are available for Mac OS X and Windows, please see the [Vagrant project download page](http://www.vagrantup.com/downloads) for more information.
  12
  13 # Setting up openstreetmap-website
  14
  15 Once Vagrant has been installed, you can start an environment by checking out the openstreetmap-website code if you haven't already, then changing to the directory which contains the Vagrantfile by typing:
  16
  17 ```
  18 git clone git@github.com:openstreetmap/openstreetmap-website.git
  19 cd openstreetmap-website
  20 vagrant up
  21 ```
  22
  23 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:
  24
  25 ```
  26 vagrant ssh
  27 ```
  28
  29 Within this login shell, you can do development, run the server or the tests. For example, to run the tests:
  30
  31 ```
  32 cd /srv/openstreetmap-website/
  33 rake test
  34 ```
  35
  36 To access the web pages you run the following commands then access the site in your [local browser](http://localhost:3000):
  37
  38 ```
  39 vagrant ssh
  40 cd /srv/openstreetmap-website/
  41 rails server
  42 ```
  43
  44 You edit the code on your computer using the code editor you are used to using, then through shared folders the code is updated on the VM instantly.
  45
  46 You should run the tests before submitting any patch or Pull Request back to the original repository. Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information.