Skip to content

1. Installing Git, Homebrew, Jekyll

Daniel Pett edited this page Dec 18, 2018 · 1 revision

The project team are generally on OSX, so this guide will work on the assumption that you will also be using this.

To get set up to run this website locally, you will need to have some software installed on your computer. The process documented below is the easiest way to get up and running. You will need to learn how to use your Mac's Terminal programme, a great guide can be found online which explains it easily. (Don't worry, looks scary, isn't.)

Installing Homebrew

Homebrew is a package manager for OSX, that installs programmes into a single directory and then symlinks them to the correct path and maintains system integrity of your machine. It is quite simple to install (if you have enough disk space.) To install open Terminal on your machine and at the command line paste:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

This will run and install all of the packages (hopefully). If you run into trouble, ask @portableant for help. Once it has run, you generally install packages using the following syntax:

brew install package

Installing Git

Git is a version-control system for tracking changes in computer files and coordinating work on those files among multiple people. It is primarily used for source-code management in software development, but it can be used to keep track of changes in any set of files.

This is really important for you as a team to keep a full track of what you're doing with this static build HTML site. To install it run the following command on the Terminal command line:

brew install git

Once that is complete, you're now almost ready to install Jekyll, which is the system that the website compiles on and runs the magic under the hood.

Installing XCODE

You will first off need to install Xcode to allow the system to run properly, if you don't have enough disk space, this is where things will go awry! At the terminal run this command:

xcode-select --install

Then agree to the license terms (you will prompted for your password when you run this command):

sudo xcodebuild -license

Once run you can now install Jekyll.

Installing Jeykll

This is a simple one line of commands and may take a while to complete!

 sudo gem install jekyll

Once this is complete, you should be ready to get the site code.