Getting Started

teracy-dev is created to set up a universal development platform which has the same development workflow on Mac, Linux and Windows with good developer experience and productivity in mind.

Please follow the installation instruction below, after that, the instruction step for teracy-dev git clone and vagrant up is the same on all the platforms.

Note

  • The 64-bit architecture is used and run every day by us, however, the 32-bit architecture is expected to work, too.

  • By default, we’re using a Ubuntu 64-bit guest OS, so you need to enable VT-x/AMD-v in the host PC BIOS. Remember to reboot your host PC after making BIOS changes. Please refer to https://forums.virtualbox.org/viewtopic.php?f=1&t=62339 for more details.

  • We recommend the following tested and supported platforms:

    • macOS Sierra
    • Ubuntu 16.04
    • Windows 10, Windows 8, Windows 7

    Other platforms are expected to work, but we haven’t fully tested them yet.

Automatic Installation on macOS

// TODO(hoatle): https://github.com/teracyhq/dev/issues/162

Manual Installation on macOS

Open the terminal window:

  1. Install Homebrew and Homebrew Cask

  2. Install virtualbox and vagrant

    • Install virtualbox (>=5.1):

      $ brew cask install virtualbox
      
    • Install vagrant (>=1.8.7, >=1.9.1):

      $ brew cask install vagrant
      

      Note

      • If you encounter the following similar error:

        ==> default: Box 'bento/ubuntu-16.04' could not be found. Attempting to find and install...
            default: Box Provider: virtualbox
            default: Box Version: >= 0
        The box 'bento/ubuntu-16.04' could not be found or
        could not be accessed in the remote catalog. If this is a private
        box on HashiCorp's Atlas, please verify you're logged in via
        `vagrant login`. Also, please double-check the name. The expanded
        URL and error message are shown below:
        
        URL: ["https://atlas.hashicorp.com/bento/ubuntu-16.04"]
        

        then fix it with $ sudo rm -rf /opt/vagrant/embedded/bin/curl (Details at https://github.com/mitchellh/vagrant/issues/7969#issuecomment-258878970)

      • // TODO(hoatle): https://github.com/teracyhq/dev/issues/175

Please check out the instruction video below for more details:

Note

The video is not really up to date with current teracy-dev v0.5.0, however, you will see the similar workflow and result.

Next: teracy-dev Git Clone and Vagrant Up

Automatic Installation on Linux (Ubuntu)

// TODO(hoatle): https://github.com/teracyhq/dev/issues/162

Manual Installation on Linux (Ubuntu)

Open the terminal window:

  1. Install git

    $ sudo apt-get update
    $ sudo apt-get install -y git
    
  2. Install virtualbox (>=5.1):

    $ sudo sh -c "echo 'deb http://download.virtualbox.org/virtualbox/debian '$(lsb_release -cs)' contrib non-free' > /etc/apt/sources.list.d/virtualbox.list" \
    && wget -q http://download.virtualbox.org/virtualbox/debian/oracle_vbox_2016.asc -O- | sudo apt-key add - \
    && wget -q https://www.virtualbox.org/download/oracle_vbox.asc -O- | sudo apt-key add - \
    && sudo apt-get update && sudo apt-get install virtualbox-5.1 -y
    
  3. Install vagrant (>=1.8.7, >=1.9.1):

    $ version=1.9.1 && cd /tmp \
    && wget $(if [ `uname -m` == "x86_64" ]; then echo "https://releases.hashicorp.com/vagrant/$version/vagrant_${version}_x86_64.deb"; else echo "https://releases.hashicorp.com/vagrant/$version/vagrant_${version}_i686.deb"; fi;) \
    && sudo dpkg -i vagrant_${version}* && rm vagrant_${version}* && cd --
    

Please check out the instruction video below for more details:

Note

The video is not really up to date with current teracy-dev v0.5.0, however, you will see the similar workflow and result.

Next: teracy-dev Git Clone and Vagrant Up

Automatic Installation on Windows

// TODO(hoatle): add this

Manual Installation on Windows

This should be the same on Windows 10, Windows 8 and Windows 7.

Follow step by step instructions below:

Note

  • You need to look after the console output, if there is no console output after some time, press “Enter” key to make sure the process should continue.
  • You must “restart the machine” when instructed to make sure we install packages properly.
  1. Install chocolatey

    Run Command Prompt as administrator and paste the Cmd.exe command copied from https://chocolatey.org/install#install-with-cmdexe section.

    It should look similar to the following command:

    > @"%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe" -NoProfile -ExecutionPolicy Bypass -Command "iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))" && SET "PATH=%PATH%;%ALLUSERSPROFILE%\chocolatey\bin"
    

    After the installation is finished, restart the machine.

  2. Install dotnet4.5

    Note

    This is required for the vagrant installation later, see more: https://github.com/teracyhq/dev/issues/348#issuecomment-315068962

    Run Command Prompt as administrator and type the following command:

    > choco install dotnet4.5 --version 4.5.20120822 -y
    

    After the installation is finished, restart the machine.

  3. Install cygwin and cyg-get

    Type the command below on the opened Command Prompt:

    > choco install cygwin --version 2.8.0 -y --ignore-checksums
    > choco install cyg-get --version 1.2.1 -y
    

    Note

    • If you cannot install the cyg-get due to the checksums error, reinstall it with the following command instead:

      > choco install cyg-get --version 1.2.1 -y --ignore-checksums --force
      
  4. Install bash-completion, git, virtualbox and vagrant

    Run Cygwin Terminal as administrator with the following commands:

    • Install bash-completion:

      $ cyg-get.bat bash-completion
      

      Note

      • From now on, let’s call Cygwin Terminal terminal window on Windows.

      • If you encounter the following error:

        C:\ProgramData\chocolatey\lib\cyg-get\tools\cyg-get.ps1 : Please ensure you have Cygwin installed.
        To install please call 'choco install cygwin' (optionally add -y to autoconfirm).
        ERROR: This command cannot be run due to the error: The system cannot find the file specified.
        At line:1 char:1
        

        then fix it by going to http://cygwin.com/install.html and save the setup-x86_64.exe file with the new name cygwinsetup.exe into the cygwin folder (Details at https://github.com/chocolatey/chocolatey-coreteampackages/issues/176#issuecomment-212939458.)

    • Install git:

      $ cyg-get.bat git
      
    • Install virtualbox (>=5.1):

      $ choco install virtualbox --version 5.1.14 -y
      
    • Install vagrant (>=1.8.7, >=1.9.1):

      $ choco install vagrant --version 1.9.1 -y
      

    After finishing the vagrant installation, restart the machine.

Please check out the instruction video below for more details:

Note

The video is not really up to date with current teracy-dev v0.5.0, however, you will see the similar workflow and result.

Next: teracy-dev Git Clone and Vagrant Up

teracy-dev Git Clone and Vagrant Up

  1. Open your terminal window and type:

    $ cd ~/
    $ git clone https://github.com/teracyhq/dev.git teracy-dev
    $ cd teracy-dev
    $ git checkout v0.5.0-c1
    $ vagrant up
    

    Note

    • Check out the develop branch to use the latest development version of teracy-dev.
    • Check out the master branch to use the latest stable version of teracy-dev.

    You should see the following similar messages after $ vagrant up finishes running:

    ==> default: [2016-11-25T06:02:16+00:00] INFO: Report handlers complete
    ==> default: Chef Client finished, 9/15 resources updated in 03 minutes 36 seconds
    ==> default: Running provisioner: shell...
    ==> default: Running: inline script
    ==> default: stdin: is not a tty
    ==> default: ip address: 192.168.0.105
    ==> default: vagrant-gatling-rsync is starting the sync engine because you have at least one rsync folder. To disable this behavior, set `config.gatling.rsync_on_startup = false` in your Vagrantfile.
    ==> default: Doing an initial rsync...
    ==> default: Rsyncing folder: /Users/hoatle/teracy-dev/workspace/ => /home/vagrant/workspace
    ==> default:   - Exclude: [".vagrant/", ".git", ".idea/", "node_modules/", "bower_components/", ".npm/"]
    

    Note

    • You may see the error on Windows:

      vagrant uses the VBoxManage binary that ships with VirtualBox and requires this to be
      available on the PATH. If VirtualBox is installed, please find the VBoxManage binary and
      add it to the PATH environmental variable.
      

      To fix this error, add the path of the VirtualBox folder to your environment variable.

      For example: In Windows, add this C:\Program Files\Oracle\VirtualBox.

      If the error still occurs, you have to uninstall and re-install virtualbox, then vagrant to fix this error.

    • On Windows, if you $ vagrant up but cannot start the VirtualBox, please find “VBoxUSBMon.inf” and “VBoxDrv.inf” in your installation directory then re-install it to fix the issue. The VirtualBox has an installation issue which was reported here

  2. Keep the first terminal window running, open a new terminal window and use the $ vagrant ssh command to access the virtual machine you have just provisioned.

    $ cd ~/teracy-dev
    $ vagrant ssh
    

    You should see the following similar messages:

    Welcome to Ubuntu 16.04.1 LTS (GNU/Linux 4.4.0-51-generic x86_64)
    
      * Documentation:  https://help.ubuntu.com
      * Management:     https://landscape.canonical.com
      * Support:        https://ubuntu.com/advantage
    
    1 package can be updated.
    1 update is a security update.
    
    
    Last login: Tue Dec  6 14:19:56 2016 from 10.0.2.2
    
  3. Check if docker and docker-compose are already installed

    After $ vagrant ssh, use the following commands:

    $ docker --version
    $ docker-compose --version
    

    Note

    In case the docker command is not found, you should $ vagrant destroy, then $ vagrant up again or $ vagrant reload --provision.

Git Setup

To work with git, complete the following guides to set up ssh keys: https://help.github.com/articles/connecting-to-github-with-ssh/

Note

On Windows, you must always use Cygwin Terminal, not Git Bash.

Congratulations, you’ve all set now!