@the-utd/themeplify NPM

Shopify builder - Themeplify

Usage

Node.js version 14.0.0 or higher

Install

Global Install:

Install using npm:

npm install -g @the-utd/themeplify

Install using yarn:

yarn global add @the-utd/themeplify

Global install using npm is preferable way to install package globally

Local Install:

Install all dependencies with yarn

yarn add --dev @the-utd/themeplify

Add and configure your config.yml file. You can copy the example from the file config.example.yml

development:
  password: XXXXXXXXXXXXXX
  theme_id: XXXXXXXXXXXXXX
  store: XXXXXXXXXXXXXX.myshopify.com
  preview_url: XXXXXXXXXXXXXX.shopifypreview.com <= [NOT REQUIRED]
  ignore_files:
    - config/settings_data.json

Note: You can use multiple environments using different environments names. Example:

development:
  password: XXXXXXXXXXXXXX
  theme_id: XXXXXXXXXXXXXX
  store: XXXXXXXXXXXXXX.myshopify.com
  preview_url: XXXXXXXXXXXXXX.shopifypreview.com <= [NOT REQUIRED]
  ignore_files:
    - config/settings_data.json

production:
  password: XXXXXXXXXXXXXX
  theme_id: XXXXXXXXXXXXXX
  store: XXXXXXXXXXXXXX.myshopify.com
  preview_url: XXXXXXXXXXXXXX.shopifypreview.com <= [NOT REQUIRED]
  ignore_files:
    - config/settings_data.json

Note: Some Shopify Apps can be broken on localhost, so you can pass additional "preview_url" param to your enviroment to fix this issue,but you will not be able to use checkout (Shopify Checkout does not work with Shopify Preview links)

Basic commands

Basic commands for work with your theme:

themeplify build - Build files

themeplify deploy - Build and deploy files

themeplify start - Build, deploy and watch files

themeplify watch - Watch files

themeplify server - Run Proxy server for the theme

themeplify download - Download theme files

themeplify zip - Archives the project

themeplify create [archive] - Create new project from scratch. You can also pass additional param archive - link to zip archive to use your own boilerplate. Default boilerplate: https://github.com/the-utd/Themeplify-Theme.

Example: themeplify create https://github.com/the-utd/Themeplify-Theme/archive/refs/heads/main.zip

Basic options

Option	Description	Default Value
-c, --config	Path to config.yml	"config.yml"
-d, --dir	Directory that command will take effect
-e, --env	Environment from config file	"development"
-a, --allenvs	Will run this command for each environment in your config file	false
-n, --nodelete	Will run deploy without removing files from shopify	false
--preview	Will run webserver using priview link	false
--nh, --nohooks	Will skip git hooks	false
--help	Show help