Creating a Development Environment for Dashboards
Vagrant is open-source software used to create lightweight and portable virtual development environments. Vagrant works like a "wrapper" for VirtualBox that can create, configure, and destroy virtual machines with the use of its own terminal commands. Vagrant facilitates the setup of environments without any direct interaction with VirtualBox and allows developers to use preferred editors and browsers in their native operating system.
Note: This document is for setting up a virtual environment on a Unix host.
Install Vagrant
- Download and install VirtualBox 4.3.12
- Do not open VirtualBox or create a virtual machine. This will be handled by Vagrant.
- Download and install Vagrant 1.6.4
- Package managers like apt-get and gem install will install an older version of Vagrant so it is required to use the download page.
Fork this repository on Github.
Clone this fork of the xtuple-dashboard respository to a directory on your host machine:
host $ git clone https://github.com/<your-github-username-here>/xtuple-dashboard.git
Connect to the Virtual Machine
Start the virtual machine:
host $ vagrant up
Connect to the virtual machine via ssh:
host $ vagrant ssh
Bundle the Ruby gems:
vagrant $ cd xtuple-dashboard
vagrant $ bundle install
Setup environment variables:
- Make a copy of the
sample.envfile named.envin the project root - Edit the
.envfile and enter the required tokens HOW?
Start the xTuple Dashboard server
vagrant $ dashing start
xTuple Dashboard
Launch your local browser and navigate to application using localhost http://localhost:3030
or the static IP Address of the virtual machine http://192.168.33.12:3030
Vagrant-less Setup
Ensure you have Ruby 2.0+ installed and then run:
host $ gem install dashing
host $ bundle install
host $ dashing start
Generating Required Access Tokens
Github:
Generating a Github Access token
Travis-CI:
vagrant $ travis login --pro && travis token --pro