README.md

{{repoName}}

{{description}}

Developers

{{author}}

Dependencies list

http://jam3-license.herokuapp.com/projects/{{repoName}}/licenses

Note: If the link is broken use http://jam3-license.herokuapp.com/projects/[repo name]/licenses ?

PROJECT DOCUMENTATION

Components

Scripts

Tests

GIT

git checkout {{repo}}

Setup

$ npm install

Folder Structure

raw-assets/json/ 		// Any static json files
raw-assets/images/		// Images that should not be texture packed
raw-assets/videos/
raw-assets/sounds/
raw-assets/fonts/
raw-assets/tp/			// Folder for the .tps files
raw-assets/tp/common/	// Folder containing images to be texture packed,
						// folder name should share the name of the tps file

Run

$ npm start

Development

Javascript Style Guide: https://github.com/Jam3/Javascript-Code-Conventions

CSS Style Guide: https://github.com/Jam3/CSS-Style-Guide

IMAGES

Name images using dashes:

• large-pixel-image.png
• cute-yellow-pepper.png

GLOBAL VARIABLES

Always make the root path to assets (image/videos..) a variable, store it in your global settings file, in both Javascript code and CSS

Because when the site goes live, those assets will come from a CDN and going in and changing all the paths the day before the site goes live is very annoying.

@{ASSET_PATH}: 'images/'; // This variable will be changed by a script when pushing to production or other environments
.background {
    background: url('@{ASSET_PATH}/images/background.png')
}

$ASSET_PATH: 'images/'; // This variable will be changed by a script when pushing to production or other environments
.background {
    background: url('#{$ASSET_PATH}/images/background.png')
}

var filePath = settings.ASSET_PATH + 'fancy/fancy-graphic.png';

{{#is framework 'react'}} To debug Redux, use this browser extension: http://zalmoxisus.github.io/redux-devtools-extension/ {{/is}}

DEPLOYMENT

$ npm run release

BROWSER SUPPORT

Browserify recently reduced support for older IE browsers (IE10 and below). This is due to the updated Buffer module. If you wish to support these browsers and are planning to use the Buffer module or use a seperate module that uses it, consider installing this browser polyfill.

Optionally you can install version 4 of the Buffer module by running this command.

npm install buffer@^4 --save-dev

You will also have to update the browserify bundle options using the require flag:

-r buffer/:buffer

This will require editing the release.js and dev.js scripts.

For more information, check out: browserify/browserify#1678

RUN TESTS

Use Budo to develop and test your modules independently before integrating into the framework.

$ cd {{repoName}}
$ budo test/thingtotest/index.js [PORT] [-- browserify args]

NPM MODULES

When installing modules be sure to use npm install --save for dependencies that will be used in the actual application deployed to the server.

And npm install --save-dev for modules that are only used on your system for workflow and development, like automated tasks etc.

List of Jam3 Node modules