diff --git a/.gitignore b/.gitignore index a4dab66e..fe9dda61 100644 --- a/.gitignore +++ b/.gitignore @@ -25,3 +25,7 @@ public/client .DS_Store *.swp + +# Ignore vagrant related files for future Contributors +.vagrant +package.box diff --git a/DEVELOMENT-ENV.md b/DEVELOMENT-ENV.md new file mode 100644 index 00000000..514b1a93 --- /dev/null +++ b/DEVELOMENT-ENV.md @@ -0,0 +1,26 @@ +#Setting up the Development Environment# + +## Introduction ## + +The steps described in the document automates the setup of the development enviroment for working with the Community Code itself. + +##Requirements## + +- [VirtualBox][1] +- [Vagrant][2] + +##How to build the VM## + +It should be easy: + + host $ git clone https://github.com/recursecenter/community.git + host $ cd community + host $ vagrant up + host $ vagrant ssh + vm $ cd /vagrant + vm $ bin/rake db:setup + +You are done now! + +[1]: https://www.virtualbox.org/ +[2]: https://www.vagrantup.com/ \ No newline at end of file diff --git a/Vagrantfile b/Vagrantfile new file mode 100644 index 00000000..96a2e7de --- /dev/null +++ b/Vagrantfile @@ -0,0 +1,10 @@ +Vagrant.configure(2) do |config| + config.vm.box = "recursecenter/community-dev" + + config.vm.network "forwarded_port", guest: 5001, host: 5001 + config.vm.network "forwarded_port", guest: 9200, host: 9200 + + config.vm.provider "virtualbox" do |vb| + vb.memory = "2048" + end +end \ No newline at end of file