03861e18fbd3a57ac76512fa29ff7db05c236714
[rails.git] / 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 changing to the directory which contains the Vagrantfile and typing:
16
17 ```
18 vagrant up
19 ```
20
21 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:
22
23 ```
24 vagrant ssh
25 ```
26
27 Within this login shell, you can do development, run the server or the tests. For example, to run the tests:
28
29 ```
30 cd /srv/openstreetmap-website/
31 rake test
32 ```
33
34 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.