Garminbygis Boilerplate

See CHANGELOG for version notes.

Development setup

Install dependencies if not present:

npm install bower

Development install:

npm install
bower install

Development build:

gulp modernizr
gulp build:debug

Continuous build:

gulp watch

Production setup

Production install and build:

npm install --quiet
bower install --quiet
gulp build:production

Production build with sourcemap files:

gulp build:production --sourcemaps

If the app deployment does not support server asset building then make sure to comment out these lines in the .gitignore:

public/assets/css/app*
public/assets/js/app*
public/assets/js/vendor*
public/assets/rev-manifest*

App config file

The build system assumes and requires an app-config.json file located on the root of your project, which it will automatically use for all gulp tasks. A sample config file is included in this repo.

In cases where a project may have or require multiple app front-ends you can specify a custom app config file using the following format:

gulp build:debug --config=app-config-custom.json or gulp build:debug -c=app-config-custom.json

You may also set the location of the app config file in an ENV variable named GULP_BUILD_APP_CONFIG.

Deployment

Via SSH

Build production assets and deploy via SSH to a server:

npm install --quiet
bower install --quiet
gulp deploy:scp --target=ENV

You can also use the short form for target -t=ENV.

Requires an SSH private key and server config in the config/scp.json file. Target ENV is used to select which data from the scp.json config.

Note: You still need to do a git ftp push -s ENV before deploying.

To a CDN S3

If the project uses a CDN (S3, Cloudfront, etc.) to distribute the build assets then you do not need to do a full build and scp deploy to the UAT or Production server. You can use an abbreviated upload which only sends the rev-manifest.json file, which is required for the correct cache-busting - using gulp deploy:scp --target=ENV --rev or gulp deploy:scp -t=ENV -r. In some deployment setups the revision manifest may be generated on the server or injected via deployment; it all depends on your project setup.

Build production assets and deploy to an S3 bucket:

npm install --quiet
bower install --quiet
gulp deploy:s3 --target=ENV

You can also use the short form for target -t=ENV.

Requires AWS credentials and S3 bucket info in the config/aws.json file. Target ENV is used to select which data from the aws.json config.

S3 upload is set up to work as the origin for a Cloudfront CDN.

To S3 for Opsworks

If the server infrastructure is managed by AWS Opsworks a custom deploy task must be used to get the correct version of the asset rev-manifest.json file into S3 for Opsworks to download and use. The build must be run from inside a git repo so that a valid revision hash can be generated.

gulp deploy:s3ops --target=ENV

NOTE: This build should only be triggered automatically, because in some cases a manual trigger could have asset file name mismatch with the git hash revision versioning of the rev-manifest file.