Include a VM

Author: joselfonseca

.gitignore

@@ -1,3 +1,4 @@
+.vagrant/
 /vendor
 /node_modules
 Homestead.yaml

Homestead.yaml.example

@@ -0,0 +1,37 @@
+---
+ip: "192.168.10.10"
+memory: 2048
+cpus: 1
+hostname: laravel-api
+name: laravel-api
+provider: virtualbox
+version: 0.3.3
+
+authorize: ~/.ssh/id_rsa.pub
+
+keys:
+    - ~/.ssh/id_rsa
+
+folders:
+    - map: "/Users/josefonseca/Documents/Code/laravel-api"
+      to: "/home/vagrant/laravel-api"
+
+sites:
+    - map: homestead.app
+      to: "/home/vagrant/laravel-api/public"
+
+databases:
+    - homestead
+
+# blackfire:
+#     - id: foo
+#       token: bar
+#       client-id: foo
+#       client-token: bar
+
+# ports:
+#     - send: 50000
+#       to: 5000
+#     - send: 7777
+#       to: 777
+#       protocol: udp

Vagrantfile

@@ -0,0 +1,29 @@
+require 'json'
+require 'yaml'
+
+VAGRANTFILE_API_VERSION ||= "2"
+confDir = $confDir ||= File.expand_path("vendor/laravel/homestead", File.dirname(__FILE__))
+
+homesteadYamlPath = "Homestead.yaml"
+homesteadJsonPath = "Homestead.json"
+afterScriptPath = "after.sh"
+aliasesPath = "aliases"
+
+require File.expand_path(confDir + '/scripts/homestead.rb')
+
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+
+    if File.exists? aliasesPath then
+        config.vm.provision "file", source: aliasesPath, destination: "~/.bash_aliases"
+    end
+
+    if File.exists? homesteadYamlPath then
+        Homestead.configure(config, YAML::load(File.read(homesteadYamlPath)))
+    elsif File.exists? homesteadJsonPath then
+        Homestead.configure(config, JSON.parse(File.read(homesteadJsonPath)))
+    end
+
+    if File.exists? afterScriptPath then
+        config.vm.provision "shell", path: afterScriptPath
+    end
+end

composer.json

@@ -31,7 +31,8 @@
         "phpunit/phpunit": "~4.0",
         "phpspec/phpspec": "~2.1",
         "scrutinizer/ocular": "~1.1",
-        "barryvdh/laravel-ide-helper": "2.1.*"
+        "barryvdh/laravel-ide-helper": "2.1.*",
+        "laravel/homestead": "^3.0"
     },
     "autoload": {
         "classmap": [

readme.md

@@ -59,6 +59,16 @@ php artisan migrate
 
 You should be done with the basic configuration.
 
+## Homestead VM
+
+The Laravel API ships with a Homestead VM that you can use as your development environment.
+
+- Create a `Homestead.yaml` file based on `Homestead.yaml.example` and modify it to suit your needs.
+- Run `vagrant up` from the project root to initialize the VM.
+- Don't forget to update your hosts file to point the domain to the Homestead machine.
+
+For more information about Homestead visit the official documentation [https://laravel.com/docs/5.2/homestead#per-project-installation](https://laravel.com/docs/5.2/homestead#per-project-installation)
+
 ## oAuth 2 Authentication server
 
 The started kit has already implemented the oAuth2 server bridge package for League/oAuth2 which means you get API authentication out of the box