gulp-shopify-upload-with-callbacks/README.md

A tool to watch and upload files to Shopify for use in theme editing

gulp-shopify-upload-with-callbacks
===================

## Introduction

**gulp-shopify-upload-with-callbacks** is a [Gulpjs](https://github.com/gulpjs/gulp) plugin forked from https://github.com/mikenorthorp/gulp-shopify-upload and then augmented to allow for callbacks after a file has been uploaded.

That project was a port of a similar plugin using Grunt called [grunt-shopify](https://github.com/wilr/grunt-shopify), thank you to the author for making a great plugin for Shopify.

## Features

- Uploads any file changes to Shopify in the folders:  `assets, layout, config, snippets, templates, locales`.
- Automatically uploads changes to the current working theme in Shopify unless a themeid is specified.
- Supports incremental file changes as well as a full site deploy for continuous integration.
- Lightweight and fast, changes are uploaded instantly.

## Basic Usage

1. Download whatever theme you are working on from Shopify to a local directory
2. Create a [private app](http://docs.shopify.com/api/authentication/creating-a-private-app) in Shopify and get the API Key and Password for it.
3. Your folder structure and gulpfile.js should have look something like below
```
shopifyTheme/
|-- gulpfile.js
|-- assets/
|-- config/
|-- layout/
|-- locales/
|-- snippets/
|-- templates/
```

**Example Gulpfile**
```
// Gulp plugin setup
var gulp = require('gulp');
// Watches single files
var watch = require('gulp-watch');
var gulpShopify = require('gulp-shopify-upload');

gulp.task('shopifywatch', function() {
  return watch('./+(assets|layout|config|snippets|templates|locales)/**')
.pipe(gulpShopify('API KEY', 'PASSWORD', 'MYSITE.myshopify.com', 'THEME ID'));
});

// Default gulp action when gulp is run
gulp.task('default', [
  'shopifywatch'
]);
```
4. The basic function call looks like
```
gulpShopify('API KEY', 'PASSWORD', 'MYSITE.myshopify.com', 'THEME ID')
```
  - `API KEY` is the API Key generated when creating a private app in Shopify
  - `PASSWORD` is the Password generated when creating a private app in Shopify
  - `MYSITE.myshopify.com` is the URL of your shop
  - `THEME ID` is the ID of your theme and is **OPTIONAL**, if not passed in, the current working theme will be used
4. Run `npm install gulp gulp-watch gulp-shopify-upload`
5. Run `gulp` and edit one of your theme files, it should automatically be uploaded to Shopify

## Advanced Usage
**Customize Your Base Deployment Path**
If your project structure is different (perhaps you use Gulpjs to compile your theme to another directory), you can change the directory from which the plugin picks up files.
To do so, simply provide an additional options hash to function call, with a `basePath` property.

```
var options = {
  "basePath": "some/other-directory/"
};

// With a theme id
gulpShopify('API KEY', 'PASSWORD', 'MYSITE.myshopify.com', 'THEME ID', options)

// Without a theme id
gulpShopify('API KEY', 'PASSWORD', 'MYSITE.myshopify.com', null, options)
```

**Deploy the Entire Site**
You can also deploy the entire site for use with continuous integration.
```
gulp.task('deploy', ['build'], function() {
  return gulp.src('./+(assets|layout|config|snippets|templates|locales)/**')
    .pipe(gulpShopify('API KEY', 'PASSWORD', 'MYSITE.myshopify.com', 'THEME ID'));
;
});
```

*Created by [Able Sense Media](http://ablesense.com) - 2015*