Skip to content

Latest commit

 

History

History
66 lines (44 loc) · 2.38 KB

README.md

File metadata and controls

66 lines (44 loc) · 2.38 KB
Raw

Create Shopify Pipeline - A project scaffolder for Shopify Pipeline

Important disclaimers:

This project is still in beta.

We are also looking for maintainers and contributors as Dynamo as a group will not be continuing active maintainance and features development for Shopify Pipeline (and it's scaffolder create-shopify-pipeline). -- See #108.

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.

Roadmap

(More to come)

Contributions

(More to come)

License

MIT, see LICENSE for details.

Thanks

We would like to specifically thank create-react-app, for the inspiration and help in regards to the creation of create-shopify-pipeline.

Made by Dynamo

This tool was created with love by Dynamo, a Montreal-based full-service digital design studio.

Cheers,

The Dynamo Team