50th Anniversary of the Chicago MLK Riots

A Tarbell project.

CHEAT SHEET

• To pull changes to blueprint, from project root, run git submodule update --init --recursive --remote
• To push changes to the project PLUS changes to blueprint, run git push --recurse-submodules=on-demand

Assumptions

• Python 2.7
• Tarbell 1.0.*
• Node.js
• grunt-cli (See http://gruntjs.com/getting-started#installing-the-cli)
• Sass

Custom configuration

DEFAULT_CONTEXT['OMNITURE']

This project uses python-tribune-omniture to render the Omniture <script> tags for the Tribune's analytics. You'll need to configure the dictionary named OMNITURE in the DEFAULT_CONTEXT dictionary in your tarbell_config.py:

DEFAULT_CONTEXT = {
    'name': 'lead',
    'title': 'Lead',
    'analytics_path': '',
    'OMNITURE': {
        'domain': 'chicagotribune.com',
        'sitename': 'Chicago Tribune',
        'section': 'news',
        'subsection': 'watchdog',
        'subsubsection': '',
        'type': 'dataproject',
    },
}

Building front-end assets

This project uses npm scripts with a little help from Grunt to build front-end assets.

To compile CSS and JavaScript for this project, first install the build tool depenencies:

npm install

When you run:

npm run build    

npm will compile sass/styles.scss into css/styles.css and bundle/minify js/src/app.js into js/app.min.js.

If you want to recompile as you develop, run:

npm run build && npm run watch

The blueprint simply sets up the the build tools to generate styles.css and js/app.min.js, you'll have to explicitly update your templates to point to these generated files. The reason for this is to make you think about whether you're actually going to use an external CSS or JavaScript file and avoid a request for an empty file if you don't end up putting anything in your custom stylesheet or JavaScript file.

To add styles.css, add this to your template file (likely, index.html):

<link rel="stylesheet" href="css/styles.css">

To add app.min.js to your template file:

<script src="js/app.min.js"></script>