Skip to content

Latest commit

 

History

History
77 lines (62 loc) · 3.75 KB

README.md

File metadata and controls

77 lines (62 loc) · 3.75 KB

A Virtual Machine for Hammer

Introduction

This project automates the setup of a development environment for working with Hammer.

How to install

  1. Disconnect from WVU's VPN

  2. Install VirtualBox

  3. Install Vagrant

  4. If you had a previous version of Hammer installed prior to v1.1.3

    • vagrant plugin uninstall vagrant-triggers
    • then you may have to run a plugin repair
    • vagrant plugin repair

  5. Install Vagrant ENV by running:

    • vagrant plugin install vagrant-env

  6. If you haven't made a Sites and cleanslate_themes folders, run:

    • cd ~ && mkdir Sites && cd ~/Sites/ && mkdir cleanslate_themes

  7. Optional Step: Custom cleanslate_themes directory location:

    1. Create a file named .env in the root directory of your hammer-vm install
    2. Add following line with path to directory:
      • CLEANSLATE_THEMES=/full/path/to/cleanslate_themes
      • Not yet tested on Windows

  8. Next, we have to build the Hammer virtual machine. cd ~/Sites/ && git clone https://github.com/wvuweb/hammer-vm.git && cd hammer-vm && vagrant up

    • NOTE: The first time you run vagrant up, it may take 5-30 minutes to build the virtual machine. On subsequent vagrant up's it will only take a few seconds.

  9. Visit localhost:2000 in the browser at to access your CleanSlate themes.

If the build fails run vagrant provision until it completes. If you have continue to have issues, open an issue.

Commands

To be ran from the /hammer-vm/ directory

vagrant up              # Start Hammer
vagrant halt            # Stop Hammer
vagrant hammer update   # Update Hammer
vagrant status          # Is the VM running?
vagrant destroy         # Destroys the VM

Mac/Linux Alias

If you would like to have aliases for the above command add the following to your .zprofile, .zshrc, .bash_profile, .bashrc, or .profile in your user root directory. OSX Catalina (10.15+) and beyond users should use .zshrc.

alias hammer-start="cd ~/Sites/hammer-vm && vagrant up"
alias hammer-stop="cd ~/Sites/hammer-vm && vagrant halt"
alias hammer-update="cd ~/Sites/hammer-vm && vagrant hammer update"

Directory structure

Truth be told, you don't actually need a Sites folder—we simply suggest it for consistency. To get Hammer working, the hammer-vm and cleanslate_themes directories must be on the same level, unless you have overridden the hammer-vm directory using a .env file.

/Sites/
|_/hammer-vm/
|_/cleanslate_themes/

ENV Overrides

You can override the following configurations with a .env file in the root of your hammer-vm directory

CLEANSLATE_THEMES=/full/path/to/cleanslate_themes       # default: ~/Sites/cleanslate_themes
HOST_PORT=2000                                          # default: 2000
DEV_ENVIRONMENT=true                                    # default: false
HAMMER_VERSION=v1.0.12                                  # default: false (pulls latest release)
                                                        # will override DEV_ENVIRONMENT set to false if
                                                        # DEV_ENVIRONMENT is being used
  • CLEANSLATE_THEMES variable enables setting any path to your cleanslate theme directory
  • HOST_PORT variable enables setting any port for the VM to bind Hammer server on
  • DEV_ENVIRONMENT variable enables latest commit versions of Hammer to be installed or specific branches
  • HAMMER_VERSION variable pins installation of a specific released versions of Hammer