jayphelps / ember-cli-deploy-original Goto Github PK

#ember-cli-deploy

An Ember-CLI addon for lightening fast deployment of applications

##Motivation

This addon was inspired by Luke Melia's RailsConf 2014 presentation - Lightning Fast Deployment of Your Rails-backed JavaScript app.

##Synopsis

This plugin is designed to aid in the deployment workflow of an Ember CLI application. The worflow is designed to follow on from a successful ember build command and runs as follows:

• Create an Ember CLI build
• Deploy assets to S3
• Deploy index.html to Redis
• (At some point afterwards) Activate a released index.html to be the current live version

##Installation

From within your Ember CLI application, run:

npm install --save-dev ember-cli-deploy

##Configuration

Any of the command line options passed in to the following commands can alternatively be either exported as environment variables or specified in a .env file.

Simply change the option flag to be UPPERCASED and UNDER_SCORED, eg:

--redis-host would be specified as REDIS_HOST

ember deploy:index

This command is responsible for pushing your index.html file to a Redis instance.

###Usage

ember deploy:index <options>

###Options

####--dist-dir (optional) Default: dist

Should point to the dist directory that contains the built index.html.

####--redis-host (required)

The host server of the Redis instance to deploy the index.html to.

####--redis-port (required)

The host port of the Redis instance to deploy the index.html to.

####--redis-password (optional) Default: null

The password of the Redis instance to deploy the index.html to.

##Tests

To run the tests, run:

npm test

##Honourable Mentions

The following sites have contributed in some way, shape or form in the creation of this addon.

• Framework agnostic, fast zero-downtime Javascript app deployment
• Lightning Fast Deployments With Rails (in the Wild).

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality.

##Maintainers

• Aaron Chambers ([email protected])

Release History

• v0.0.1