uvalib/faulkner

Faulkner exhibit marketing page

This exhibition has passed. Content on this site is no longer maintained. Hence the reason this repository is archived.

Faulkner Exhibition

Faulkner exhibit marketing page

Credits

• Anthony Jones - UX Design and Development @iamtonybagels
• Holly Robertson - Content
• Jeff Hill - Illustrations

Open Source Projects

• Stefan Kovac, Flex Layout Attribute
• Nick Williams - Headroom JS
• Davide Calignano - Medium Lightbox

Prerequisites

To install this project, you'll need the following things installed on your machine.

• Jekyll - $ gem install jekyll
• NodeJS - use the installer
• NPM - $ npm install npm -g
• Update Bundler - $ bundle update

Local Installation

1. Clone this repo, or download it into a directory of your choice.
2. Inside the directory, run npm install.
3. Then run bundle update.

Usage

Development mode

To build your site run the following command

$ gulp

This will give you file watching, browser synchronisation, auto-rebuild, CSS injecting etc.

$ gulp serve

Deploy to Development - https://uvalib.github.io/faulkner/

You can easily deploy your site build to GitHub pages with the command

$ gulp deploy-to-test

Deploy to Production - http://faulkner2017.lib.virginia.edu/

You can easily deploy your site build to UVA Libraries production server with the command

$ git push origin master

Tests

You can run accessibility test set to WCAG Level AA

$ gulp accessibility

If you want to run the HTML tests on your local machine please install gem install html-proofer. And then run the tests using

$ htmlproofer ./_site

Content Writers

1. Edit the files in the master branch
2. Build will automatically begin
3. View your changes in production at http://faulkner2017.lib.virginia.edu/