Step 1: Clone the repository

To build the website locally, first clone the repository:

  • Open terminal
  • Type: git clone https://github.com/Taming-the-BEAST/blotter.git

Step 2: Install dependencies

The website is built with Jekyll, a popular static site generator. In addition, a Ruby script is used to update the site's tutorials. We recommend using Bundler to install and run Jekyll. Bundler manages Ruby gem dependencies, reduces Jekyll build errors, and prevents environment-related bugs.

Check if you have an up-to-date version of Ruby installed:

  • Open terminal
  • Type: ruby --version

If you don't have Ruby 2.0.0 or higher installed go here to install Ruby.

  • Install Bundler: gem install bundler

Now you can install the necessary Ruby dependencies:

  • Navigate to the blotter directory.
  • Type: bundle install

You may need admin rights to perform the last step. If you run into difficulties remove the file Gemfile.lock and try again.

Step 3: Build the site

You can build the website by typing:

  • bundle exec jekyll build

Alternatively, you can preview the website locally by starting a Jekyll server:

  • Type: bundle exec jekyll serve
  • In your browser navigate to http://localhost:4000

To include the tutorials in the website you have to run a Ruby script that will clone all the tutorials locally:

  • Navigate to the blotter directory
  • Type: ruby _scripts/update-and-preprocess.rb
  • Recompile the website

Note that this script uses octokit to request metadata from GitHub. Since unauthorized requests are rate-limited you should probably generate a personal GitHub access token and use that to authorize your requests. The token itself can be generated from your GitHub profile page, under Developer settings. Copy the token and add it to your environment as follows,

export GITHUB_TOKEN=<token>

Since you do not want to generate a new token every time you restart your environment you will probably want to save the token in a secure location. (do NOT add the token to any of your GitHub repositories!)

Useful links