Shopify Theme Development Scaffold
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
.gitignore
Readme.md
bower.json
config.example.yml
gruntfile.js
package.json

Readme.md

Shopify Scaffold

Installation

  1. After cloning the repo, run the following command to install required development javascript packages:

    npm install
  2. Copy config.example.yml to config.yml and add application secrets from:

    https://<shop_name>.myshopify.com/admin/apps/private

  3. Before you start development, start grunt watcher to watch for file changes and automatically upload them to shopify:

    grunt

Note: Shopify does not allow subdirectories in /assets directory. All files in /assets/stylesheets, /assets/javascripts and /assets/svgs will be automatically compiled and added to /assets directory. The other subdirectories are ignored.

Images should be placed in /assets directory, without any specific subdirectory.

Adding dev dependencies

To add a development dependency, such as grunt dependencies (svgstore, uglify, etc.), find the npm package you'd like to add and run:

yarn add --dev <package_name>

If you don't have yarn, install it from npm:

npm install -g yarn

Adding runtime dependencies

To add a javascript/stylesheet library that will be used in production, such as jQuery or Zurb Foundation, find the bower package you'd like to add and run:

bower install <package_name> --save

Check /assets/javascripts/vendor directory and remove any unnecessary additional files that were downloaded.