CardKit v1.2

Forked from Meme, customised for The Times and The Sunday Times.

Contributors: Chris Hutchinson (@chrishutchinson), Matthew Taylor (@mattietk)

Install

• git clone https://github.com/times/cardkit.git
• sudo gem install bundler
• bundle install
• bundle exec middleman

This will start a local web server running at: http://localhost:4567/

Build

Build into the /build directory by running bundle exec middleman build.

Customization

Configuration

Settings and controls are configured through source/javascripts/settings.js.erb. The settings file has ample comments to document configuration.

Fonts

Include your own fonts in stylesheets/_fonts.scss, then add your font options into the settings file.

Editor theme

Set the theme-color variable in source/stylesheets/_vars.scss. That one color will be tinted across all editor controls.

Cross-Origin Resources (CORS)

This is an HTML5 Canvas-based application, and thus comes with some security restrictions when loading graphics across domains (ex: a canvas element on http://tatooine.com cannot export with an image hosted on http://dagobah.com).

If you're hosting this application on the same domain that serves your images, then congratulations! You have no problems. However, if you're going through a CDN, then you'll probably encounter some cross-domain security issues; at which time you have two options:

1. Follow this excellent MDN article about configuring "Access-Control-Allow-Origin" headers. You'll need to enable these headers on your CDN, at which time the Meme app should be able to request images from it.

2. Embed all of your watermark images as base64 data URIs within the settings.js.erb file. The asset pipeline's asset_data_uri helper method makes this very easy, and effectively embeds all image data within your JavaScript. The downside here is that your JavaScript will become a very large payload as you include more images. In the long term, getting CORS headers configured will be a better option.