knowallthingsarepossible / shopify.github.com

A collection of the open source projects by Shopify

Shopify Open Source

Shopify's Open Source page is build with Jekyll and Sass and hosted on GitHub Pages.

If you want to run it locally

1. Clone this branch or download the zip and navigate to the folder in terminal
2. Install Jekyll: gem install jekyll
3. Install Sass: gem install sass
   • Use sass -v to make sure it worked
4. Install Compass: gem install compass
5. Make sure everything is setup with bundle install
6. Run jekyll serve --watch
7. In another terminal window, run compass watch
8. Access the docs at http://localhost:4000

Notes about local build

• jerkyll serve --watch will compile the Jekyll and Sass files into static assets in the _site folder each time a file is saved. That folder is excluded from the repo.
• compass watch will update ie.css and main.css.
• Use rake build to manually parse SCSS files.
• Your local build will be nearly empty because:
  • The page uses Jekyll's site.github.public_repositories object to get the repo data. This data is only available when live.
  • Custom repo data is generated by Github's JS API, so it will show up locally.

Dependencies (all included)

• jQuery 1.9
• Modernizr
• Bourbon
• Handlebars.js
• Isotope