abcnews/interactive-queens-birthday-honours-map

Name: interactive-queens-birthday-honours-map

Owner: ABC News

Description: null

Created: 2017-05-30 23:30:04.0

Updated: 2017-05-30 23:30:29.0

Pushed: 2017-05-30 23:30:28.0

Homepage: null

Size: 799

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

interactive-queens-birthday-honours-map

An interactive map showing location of QBH recipients.

Dependencies

• Node.js
• Ruby
• Sass & Compass

If you're on OS X or Linux you probably already have Ruby installed; test with ruby -v in your terminal. When you've confirmed you have Ruby installed, run gem update --system && gem install compass to install Compass and Sass.

Getting Started

m start

This will run npm install to locally install Node package dependencies, then run the default grunt task which:

• Runs grunt dev to create a development build (see Tasks, below)
• Starts up a development server in the build directory, running on http://localhost:8000
• Watches files under src/ for changes, triggering partial development builds as required

Grunt Tasks

The build tasks transform the project source in src/ into a build under build/.

Development Build: $ grunt dev

Creates a local development build of the project.

• JS in scripts/ is linted by JSHint, then bundled by Browserify into scripts/index.js
• Sass in styles/ is compiled by Compass into styles/index.css
• All other directories/files are copied directly across, including those directly under src/ (such as index.html)

Hint: If you organise your static files into directories called images, fonts & data, you'll have the benefit of proper caching by Akamai when you deploy to contentftp.

Production Build: $ grunt prod

Creates a production-ready build of the project.

The build process is similar to the development build, except that scripts and styles are minified with the current version number (specified in package.json) prepended as a comment.

Deployment $ grunt deploy and $ grunt release

Quickly deploy and/or create new releases from the commandline. See the documentation for news-deploy-project-grunt for more details.

Default: $ grunt

Described above in Getting Started