Setting up your system
Since Wax uses your local machine to produce all of the static site pages and elements in HTML, CSS, and Javascript, using Wax requires you to install dependencies on your machine. This documentation will only include the full text and an extension of Minicomp’s Manual Installation Guide. If you wish to use Docker, please see the Docker Installation Guide.
Table of Contents
Note that some of the content below has been copied from the original Wax documentation and can be credited to Minicomp and its contributors.
Requirements
- Homebrew (on Mac OS)
- Ruby (a recent version); this version should be set up so that it does not conflict or overwrite your system’s endemic Ruby version. See rbenv or RVM for details
- Bundler (as part of your Ruby installation)
- Image Magick
- Ghostscript
- Git
- libvips
- GitHub Desktop
Installing on Mac
- Open the Terminal.
- If you’ve never used the Terminal before, open the Applications folder on your Mac. Open the Utilities folder and find Terminal.app.
- Check to see if you have Homebrew installed by pasting
brew -v
into the command line and pressing the return key.- If you do not have Homebrew installed, follow the Homebrew installation instructions.
- Install Git and Gnupg by running the following command:
brew install git gnupg
- Install Ghostscript, libvips, and ImageMagick by running the following command:
brew install imagemagick ghostscript libvips
- Lastly, install Ruby using RVM by running the following commands:
gpg --keyserver hkp://pool.sks-keyservers.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
\curl -sSL https://get.rvm.io | bash
- Quit and reopen the terminal. Then run the following command to get a Ruby version that comes with Bundler:
rvm install 2.7.2
- Install GitHub Desktop by going to the download page and following the instructions.
- If you do not already have a GitHub account, make one by following the signup instructions.
Installing on Windows
- Install Ruby by following the Ruby Installer for your Windows version. On the last installation step make sure to run the
ridk install
step on the last step of the installation wizard. - Install Git for Windows, following the installation guide.
- Install Image Magick for Windows, following the installation guide.
- Install Ghostscript Postscript and PDF interpreter/renderer, following the Download page instructions.
- Download and open the libvips
.zip
file from the libvips GitHub page - Install GitHub Desktop by going to the download page and following the instructions.
- If you do not already have a GitHub account, make one by following the signup instructions.
When you’re done installing everything, check the requirements to make sure you’ve got all your dependencies installed.