README.md

This is a template for websites implemented using Jekyll.

Project Dependencies

Dependencies required for this project are:

• Python 3.5.2
• Node 4.5.0
• Ruby 2.3.3
• Ruby DevKit

Windows Installation

Installing Python

https://www.python.org/ftp/python/3.5.2/python-3.5.2.exe

This documentation assumes an installation path of c:/Python35.

When installing Python:

• Choose 'Customize Installation'

• On 'Optional Features':

  Check 'pip' and 'for all users (requires elevation)'.

  Uncheck 'Documentation', 'tcl/tk and IDLE', 'Python test suite', 'py launcher'.

• On 'Advanced Options':

  Set an installation path of c:/Python35.

  Uncheck all options.

Creating a Virtual Environment and Installing Dependencies

Create the virtual environment. From the working directory of our project (e.g., c:/devel/web-jekyll-base):

c:/Python35/python.exe -m venv env35

This will create a directory for the virtual environment (e.g., c:/devel/web-jekyll-base/env35/).

Next activate that virtual environment and install our Python dependencies:

env35/Scripts/activate.bat
pip install -r requirements3.txt

Installing Node

https://nodejs.org/dist/v4.5.0/node-v4.5.0-x64.msi

The default installation options are appropriate.

Installing Ruby

https://dl.bintray.com/oneclick/rubyinstaller/rubyinstaller-2.3.3.exe

This documentation assumes an installation path of c:/Ruby233.

When installing Ruby:

• On 'Installation Destination and Optional Tasks':

  Set an installation path of c:/Ruby233.

  Check 'Add Ruby executables to your PATH'.

Installing Ruby DevKit:

https://dl.bintray.com/oneclick/rubyinstaller/DevKit-mingw64-32-4.7.2-20130224-1151-sfx.exe

This documentation assumes an installation path of c:/RubyDevKit.

When installing the Ruby DevKit:

• Extract to c:/RubyDevKit.

• Install the DevKit into the Ruby installation:

  cd c:/RubyDevKit
  ruby dk.rb init
  ruby dk.rb install
  

Mac Installation

Installing Homebrew

This documentation assumes use of Homebrew: https://brew.sh/.

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

The default installation options are appropriate.

Installing Python

brew install python3

Installing python3 via Homebrew should automatically install pip3. Use that to install virtualenv.

pip3 install virtualenv

Creating a Virtual Environment and Installing Dependencies

Create the virtual environment. From the working directory of our project (e.g., ~/Desktop/web-jekyll-base):

virtualenv -p python3 env35

This will create a directory for the virtual environment (e.g., ~/Desktop/web-jekyll-base/env35/).

Next activate that virtual environment and install our Python dependencies:

source env35/bin/activate
pip3 install -r requirements3.txt

Installing Node

brew install node

Installing Ruby

brew install rbenv

Configure the terminal to include rbenv:

echo 'if which rbenv > /dev/null; then eval "$(rbenv init -)"; fi' >> ~/.bash_profile`
source ~/.bash_profile`

Install the correct version of Ruby:

rbenv install 2.3.3
rbenv global 2.3.3

Alternatively, you can specify a Ruby version for the directory:

rbenv local 2.3.3

Installing Ruby DevKit:

Installing rbenv via Homebrew should automatically install ruby-devkit

Building and Serving the Site

Invoke automation is provided for building the site.

If it is not already active, you need to re-activate the virtual environment. From the working directory of our project:

env35\Scripts\activate.bat

To build the site:

invoke build_test

To build and serve the site on localhost:4000, continuously updating based on changes:

invoke serve_test