Create-shopify-pipeline NPM

Create Shopify Pipeline - A project scaffolder for Shopify Pipeline

(Disclaimer: This project is still in beta.)

create-shopify-pipeline is a companion tool to help scaffold Shopify Pipeline projects and easily get started on theme developement.

What is Shopify Pipeline?

It is a simple command line interface (CLI) which aims at giving you access to a better, smoother and more modern workflow for building, testing and deploying Shopify themes and websites.

You can learn more about it here: https://github.com/DynamoMTL/shopify-pipeline.

Getting Started

Install with Yarn (recommended)

For yarn >= 0.24.0:

$ yarn create shopify-pipeline MyShopifyTheme

For yarn < 0.24.0:

$ yarn global add create-shopify-pipeline 
$ create-shopify-pipeline MyShopifyTheme

Install with NPM

$ npm i -g create-shopify-pipeline
$ create-shopify-pipeline MyShopifyTheme

Setup your Shopify environments

Once you have bootstraped your development app, you will need to setup your shopify.yml file with the right information provided by Shopify, as described here: https://github.com/DynamoMTL/shopify-pipeline#setup-your-shopify-environments.

Project Structure

create-shopify-pipeline will scaffold a brand new project for you, with the necessary folders and files, which you can get more details about here: https://github.com/DynamoMTL/shopify-pipeline#project-structure.

Using the Tool

Now that you have generated a project, you can use the CLI in your development and deployment flows, as described here: https://github.com/DynamoMTL/shopify-pipeline#using-the-tool.