# @hodzitsky/themeplify

> ---

Latest version **1.1.8** (published 2024-09-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install @hodzitsky/themeplify
pnpm add @hodzitsky/themeplify
yarn add @hodzitsky/themeplify
bun add @hodzitsky/themeplify
```

Provides the command `themeplify`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.8 |
| Published | 2024-09-10 |
| First published | 2024-03-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=14.0.0 |
| Dependencies | 54 |
| Unpacked size | 73.7 KB |
| Known vulnerabilities | 0 (+29 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 15 |
| Maintainers | hodzitsky |

## Links

- npm: https://www.npmjs.com/package/@hodzitsky/themeplify
- Repository: https://github.com/the-utd/Themeplify
- Homepage: https://github.com/the-utd/Themeplify/blob/main/README.md
- Issues: https://github.com/the-utd/Themeplify/issues
- npm.io page: https://npm.io/package/@hodzitsky/themeplify

## Dependencies (54)

- [gulp](https://npm.io/package/gulp.md) ^4.0.2
- [sass](https://npm.io/package/sass.md) ^1.29.0
- [yaml](https://npm.io/package/yaml.md) ^1.10.0
- [axios](https://npm.io/package/axios.md) ^0.21.0
- [yargs](https://npm.io/package/yargs.md) ^16.0.4-candidate.0
- [rollup](https://npm.io/package/rollup.md) ^3.9.1
- [core-js](https://npm.io/package/core-js.md) ^3.6.5
- [cssnano](https://npm.io/package/cssnano.md) ^4.1.10
- [gulp-if](https://npm.io/package/gulp-if.md) ^3.0.0
- [gulplog](https://npm.io/package/gulplog.md) ^1.0.0
- [postcss](https://npm.io/package/postcss.md) ^8.1.7
- [webpack](https://npm.io/package/webpack.md) ^4.1.0
- [gulp-cli](https://npm.io/package/gulp-cli.md) ^2.3.0
- [gulp-zip](https://npm.io/package/gulp-zip.md) ^5.0.2
- [through2](https://npm.io/package/through2.md) ^4.0.2
- [find-root](https://npm.io/package/find-root.md) ^1.1.0
- [gulp-copy](https://npm.io/package/gulp-copy.md) ^4.0.1
- [gulp-sass](https://npm.io/package/gulp-sass.md) ^5.1.0
- [gulp-svgo](https://npm.io/package/gulp-svgo.md) ^2.1.1
- [gulp-clean](https://npm.io/package/gulp-clean.md) ^0.4.0
- [@babel/core](https://npm.io/package/@babel/core.md) ^7.14.6
- [cross-spawn](https://npm.io/package/cross-spawn.md) ^7.0.3
- [gulp-cached](https://npm.io/package/gulp-cached.md) ^1.1.1
- [gulp-filter](https://npm.io/package/gulp-filter.md) ^6.0.0
- [gulp-minify](https://npm.io/package/gulp-minify.md) ^3.1.0
- [gulp-rename](https://npm.io/package/gulp-rename.md) ^2.0.0
- [webpack-cli](https://npm.io/package/webpack-cli.md) ^4.7.2
- [autoprefixer](https://npm.io/package/autoprefixer.md) ^9.7.4
- [babel-loader](https://npm.io/package/babel-loader.md) ^8.2.2
- [browser-sync](https://npm.io/package/browser-sync.md) ^2.27.4
- [gulp-plumber](https://npm.io/package/gulp-plumber.md) ^1.2.1
- [gulp-postcss](https://npm.io/package/gulp-postcss.md) ^9.0.0
- [serve-static](https://npm.io/package/serve-static.md) ^1.14.1
- [gulp-prettier](https://npm.io/package/gulp-prettier.md) ^3.0.0
- [node-datetime](https://npm.io/package/node-datetime.md) ^2.1.2
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.20.7
- [gulp-download2](https://npm.io/package/gulp-download2.md) ^1.1.0
- [postcss-import](https://npm.io/package/postcss-import.md) ^13.0.0
- [prompt-confirm](https://npm.io/package/prompt-confirm.md) ^2.0.4
- [webpack-stream](https://npm.io/package/webpack-stream.md) ^5.2.1
- [gulp-decompress](https://npm.io/package/gulp-decompress.md) ^3.0.0
- [gulp-dependents](https://npm.io/package/gulp-dependents.md) ^1.2.5
- [gulp-sourcemaps](https://npm.io/package/gulp-sourcemaps.md) ^2.6.5
- [readable-stream](https://npm.io/package/readable-stream.md) ^4.3.0
- [postcss-prettify](https://npm.io/package/postcss-prettify.md) ^0.3.4
- [postcss-reporter](https://npm.io/package/postcss-reporter.md) ^6.0.1
- [@babel/preset-env](https://npm.io/package/@babel/preset-env.md) ^7.14.7
- [@shopify/themekit](https://npm.io/package/@shopify/themekit.md) ^1.1.10
- [webpack-dev-server](https://npm.io/package/webpack-dev-server.md) ^3.11.2
- [regenerator-runtime](https://npm.io/package/regenerator-runtime.md) ^0.13.7
- [webpack-dev-middleware](https://npm.io/package/webpack-dev-middleware.md) ^5.0.0
- [webpack-hot-middleware](https://npm.io/package/webpack-hot-middleware.md) ^2.25.0
- [@savchukoleksii/gulp-shopify-theme-settings-tool](https://npm.io/package/@savchukoleksii/gulp-shopify-theme-settings-tool.md) ^1.0.0
- [@savchukoleksii/gulp-shopify-theme-translations-tool](https://npm.io/package/@savchukoleksii/gulp-shopify-theme-translations-tool.md) ^0.0.1

## Recent versions

- 1.1.8 (latest) — 2024-09-10
- 1.1.7 — 2024-09-10
- 1.1.6 — 2024-09-10
- 1.1.5 — 2024-08-25
- 1.1.4 — 2024-08-25
- 1.1.3 — 2024-08-25
- 1.1.2 — 2024-08-25
- 1.1.1 — 2024-08-25
- 1.1.0 — 2024-08-25
- 1.0.9 — 2024-08-25
- 1.0.8 — 2024-08-24
- 1.0.7 — 2024-07-20
- 1.0.6 — 2024-07-20
- 1.0.5 — 2024-07-20
- 1.0.4 — 2024-07-20
- … 3 more at https://npm.io/package/@hodzitsky/themeplify/versions

## README

# Shopify builder - Themeplify

---

## Usage
**Node.js version 14.0.0 or higher**

## Install

**Global Install:**

* Install using [npm](https://www.npmjs.com/):
```bash
npm install -g @hodzitsky/themeplify
```

* Install using [yarn](https://yarnpkg.com/):
```bash
yarn global add @hodzitsky/themeplify
```

`Global install using npm is preferable way to install package globally`

**Local Install:**
* Install all dependencies with [yarn](https://yarnpkg.com/)
```bash
yarn add --dev @hodzitsky/themeplify
```

* Add and configure your config.yml file. You can copy the example from the file [config.example.yml](./config.example.yml)

```yaml
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:

```yaml
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 														|  					|

## Documentation
It is important!
* [File structure](./docs/file-structure.md)
* [JavaScript](./docs/js.md)
* [CSS](./docs/css.md)
* [Examples of usage](./docs/example-usage.md)
* [Icons](./docs/icons.md)

## Last changes
All recent changes are available here: [changelog](./docs/changelog.md).
Bugs and feature-request here: [issues](/issues).

## Maintainers & Contributors
- @devoiutd - core maintainer
- @savchukoleksii

---
_Source: https://npm.io/package/@hodzitsky/themeplify · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
