dev-environment

This repository serves as guide to setting up various development environments, most of which currently used Vagrant. It provides custom vagrantfiles and setup scripts for vagrant instances. To contribute your own development environment setup, please see the contributing section below.

Environment Listing

• basic-web
  • Includes widely used web development tools including Node.js, Sass, Bower, Grunt, etc.
  • Uses Vagrant.
• mobile
  • Includes frameworks and tools for both native and hybrid mobile development (in-progress)
  • Uses Vagrant.
• multi-machine
  • Deploy multiple VMs via Vagrant.
  • Uses Vagrant.
• react-babel-webpack
  • A web dev environment/template for building react applications in ES6. The development and deployment process is made simple via my custom config script.
  • No Vagrant, bare-machine for now.

Setting up Vagrant

Resources

• https://www.vagrantup.com/docs/getting-started/
• https://www.vagrantup.com/docs/getting-started/project_setup.html
• https://atlas.hashicorp.com/boxes/search

Installing

• Install VirtualBox
• Install Vagrant

Installing a Box

• vagrant box add

Configuring the Vagrantfile

• Configure project to use a specific box as a base.

  config.vm.box = "hashicorp/precise64"

• Set up port fowarding on your vm

  config.vm.network "forwarded_port", guest: 3000, host: 3000

• Provide a provisioning script (commented out by default)

config.vm.provision "shell", path: "install.sh"

Running

• vagrant up
• vagrant ssh

Stopping

• vagrant halt
  • run from your host

Removing

• Use VirtualBox to remove your VM or run vagrant destroy

Managing VMs

• VBoxManage list vms
  • Get all instances by name and UUID
• VBoxManage list runningvms
  • Get all running instances by name and UUID
• VBoxManage unregistervm --delete "<name of machine>"

Environment Configuration Script & Installing Dependencies

• Once you complete the setup steps, you can create a setup script install.sh
• Once completed, ssh into your running Vagrant instance.
• cd to /vagrant (where the shared folder is)
• Run your install script with
  • sh install.sh
    • You made need to run chmod +x install.sh to change the permissions before running.
  • If you configured your instance to use the Vagrant provisioner, you can skip this step.
• Run this script on every instance of your environment for and update it regularly to maintain consistency among your developers.
• Open an editor on your host machine and begin developing!

Using an environment from this repository

• Make sure you followed the installation steps for Vagrant and VirtualBox.
• Download the vagrantfile and install script from one of the environments provided in this repo.
• Follow the rest of the setup/install steps.

Contributing

• Add your environment under environments/<name>.
• Include an install.sh script
• Include a README.md that provides description of your environment, a list of dependencies are your script installs, and the box your script uses. Specify whether or not your vagrantfile is set to automatically provision the vm. Feel free to add any additional notes.
• See the current environments for a template.
• Submit a pull request!

About

Author:

• Andy Vuong