X-Git-Url: https://git.openstreetmap.org/rails.git/blobdiff_plain/b460deaead10e238a375bdcd4cc0dcbfeb9da539..3d0c9057625e34d6d688d974d12a2f3b7d66ea6d:/VAGRANT.md diff --git a/VAGRANT.md b/VAGRANT.md index 03861e18f..3825ad988 100644 --- a/VAGRANT.md +++ b/VAGRANT.md @@ -6,15 +6,20 @@ 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. +Other Linux distributions should have similar installation instructions using `dnf`, `pacman`, or similar. -Installers are available for Mac OS X and Windows, please see the [Vagrant project download page](http://www.vagrantup.com/downloads) for more information. +Installers are available for Mac OS X and Windows, please see the [Vagrant project download page](http://www.vagrantup.com/downloads.html) for more information. + +Note than until there are suitable _xenial64_ [vagrant boxes](https://atlas.hashicorp.com/boxes/search?utf8=%E2%9C%93&sort=&provider=&q=xenial64) for other providers, +the only virtualization provider supported is virtualbox. You might need to install it and specify `--provider virtualbox` when setting up your environment. # 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: +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: ``` +git clone git@github.com:openstreetmap/openstreetmap-website.git +cd openstreetmap-website vagrant up ``` @@ -31,4 +36,14 @@ cd /srv/openstreetmap-website/ rake test ``` +To access the web pages you run the following commands then access the site in your [local browser](http://localhost:3000): + +``` +vagrant ssh +cd /srv/openstreetmap-website/ +rails server --binding=0.0.0.0 +``` + +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. + 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.