local-development.md

Local Development

Set Up Dev Environment

Prerequisites

• Git
• Ruby via RVM

Steps

1. Clone the repo and change directory into it

git clone [email protected]:nyu-dh/nyu-dh.github.io.git && cd nyu-dh.github.io

2. Install and/or load the relevant Ruby version

rvm install $(cat .ruby-version)

2. Install Ruby gem dependencies

bundle install

Pull Data

Optionally, fetch most up-to-date site data. (See Pulling Data from Google Sheets)

Serve the Site

Serve the site with livereload by running the following command.

bundle exec jekyll s --livereload

Then preview the site in browser at http://127.0.0.1:4000/.

You can quit the server with Ctl-C on Mac.

See also Jekyll Serve Command Options.

Run tests

You can run the tests with the following command:

bundle exec rake site:test

This will build the site and flag broken HTML formatting and any broken links.