This project is no longer maintained. Use drm2/vebs instead. As I have grown, so has my understanding of Vagrant and general dev processes. This project is a bit outdated, and my new Vagrant project, vebs, provides a clean, maintainable solution to this same problem (and then some!). Please check it out!
- David R. Myers II
A Node.js (or io.js) development environment built on Vagrant. Get up and running in about 60 seconds.
This environment will allow you to build Node apps with minimal setup. You only need to have a couple of things to get started:
- VirtualBox: https://www.virtualbox.org/
- Vagrant: https://www.vagrantup.com/
You should be able to use your choice of virtual machines, but I have only tested this in VirtualBox. If you have any problems, be sure to create an issue.
After you have those set up, you can get started by cloning this repo:
git clone https://github.com/drm2/vagrant-node-env.git node-envNow, you can move into the new directory and launch the VM:
cd node-env
vagrant upNote: Vagrant will download the necessary box automatically if it isn't already on the machine.
After a few minutes of downloading, upgrading, and configuring the box, you will have a fully functional Node dev environment with npm, mongodb, and redis. A couple of things to keep note of:
- The
wwwdirectory is synced to/home/vagrant/www - Port
1337in the VM is mapped to1337on localhost
- PM2: Process Manager
- Gulp: Streaming Build System
- Grunt: Task Runner
- Bower: Front-End Package Manager
- Yeoman: Project Scaffolding Tool
- Testem: Test Runner
- Karma: Test Runner
- Jasmine: Testing Framework
If you want to customize your included packages (see the above list), then you can easily do so by changing the postinstall.sh script. This script is run as the vagrant user, not root.
SSH into your vagrant box and launch the test server:
vagrant ssh
cd www/default
npm install
npm startNow, open localhost:1337 in your browser on your host machine. If everything worked correctly, you should see a "Hello, World!" message.
This environment uses nvm in order to manage different versions of Node. If you aren't familiar with nvm, it is a tool that allows you to manage multiple versions of Node without overriding your other Node installs.
If you want to use io.js in place of Node by default, you can run nvm alias default iojs. This will link the node command to io.js instead of Node.js starting with your next terminal session.
If you just want to temporarily switch between Node.js and io.js, you can use the nvm use iojs and nvm use node commands as needed.
Since Windows file path limits are set to 260 characters by default, Vagrant will mount the www shared folder as a UNC path. This enables "long paths" in Windows, and should solve the common problem with npm installs failing under a Windows host.
If you'd like more information about how I built this solution into the Vagrant environment, you can view the source of the Vagrantfile or view this commit where I first implemented it.
If you don't want to enable symlinks in your shared directories (this is enabled by default), you can use npm install --no-bin-links instead of the standard install method.