🛍 Shopify Theme Customizer

An effective development tool for customizing existing Shopify themes. It's built with Gulp, BrowserSync, Shopify Theme Kit, Shopify Theme Check, ESlint, Prettier, ... and Passion.

Experience

These are my experience when I have been working on this tool:

• Using Gulp to Automate & Enhance the Development Workflow.
• Using BrowserSync to Reload the Browser Automatically When Saving the Files.
• Using Shopify Theme Check, ESlint to Follow Theme Best Practices.
• Using Shopify Theme Kit to Download, Develop and Deploy the Themes.
• Using Liquid & Prettier Visual Studio Code Extensions to Format the Source Code.

If you like the project, please hit the STAR button to support my work. ⭐️

Installation

Clone the source code into your computer.

git clone https://github.com/maxvien/shopify-theme-customizer.git

Install the project's dependencies.

yarn install

Configuration

To config the project, you need to copy and rename the config.yml.example file to the config.yml file. Then update the store, password, theme_id properties.

There are two sections in the config.yml file:

• The development section is for your development store.
• The production section is for your production store.

development:
  store: store-name.myshopify.com
  password: store-admin-api-password
  theme_id: store-theme-id

production:
  store: store-name.myshopify.com
  password: store-admin-api-password
  theme_id: store-theme-id

Store Property

To fill the store property, you copy your store's hostname and paste it to the config.yml file.

Password Property

To fill the password property, please follow these steps:

1. From your Shopify admin, click Apps.
2. Near the bottom of the page, click Manage private apps.
3. If private app development is disabled, then click Enable private app development. Only the store owner can enable private app development.
4. Click Create new private app.
5. In the App details section, fill out the app name and your email address.
6. In the Admin API section, click Show inactive Admin API permissions.
7. Scroll to the Themes section and select Read and write from the dropdown.
8. Click Save.
9. Read the private app confirmation dialog, then click Create app.
10. In the Admin API section of the App, copy the password and paste it into the config.yml file.

Theme ID Property

To fill the theme_id property, please follow these steps:

1. From your Shopify admin, click Online Store.
2. At the top of the Online Store menu, click Themes.
3. In the Current theme section, click Actions and select Duplicate to backup your current theme.
4. Next, click the Customize button.
5. There is a link like this https://store-name.myshopify.com/admin/themes/[theme_id]/editor on your browser's address bar. Copy the theme_id and paste it into the config.yml file.

Download

To download your theme, you need to follow the Configuration to config the production section in the config.yml file.

Next, run this command to download the theme from your production store.

yarn get

Development

To develop the theme, you need to follow the Configuration to config the development section in the config.yml file.

Next, run this command to run the development server.

yarn dev

Open https://localhost:8080/?preview_theme_id=[theme_id] with your browser to see the result.

Shopify Theme Check

To follow Shopify Theme best practices, you need to install Shopify Theme Check.

Visual Studio Code Extensions

To speed up your productivity, you can install these extensions:

• Liquid
• ESlint
• Prettier
• Theme Check
• IntelliSense for CSS
• Material Icon Theme

Production

To deploy the theme, you need to follow the Configuration to config the production section in the config.yml file.

Next, run this command to deploy the theme to your production store.

yarn deploy

Related Projects

• Next Shopify Storefront • A real-world Shopping Cart built with TypeScript, NextJS, React, Redux, Apollo Client, Shopify Storefront GraphQL API, ... and Material UI.
• Bootstrap Shopify Theme • A free Shopify Theme built with Bootstrap, BEM, Theme Tools, Swiper, Gulp, Parcel, Liquid, SASS, PostCSS, ESNext, ... and Passion.
• Shopify Data Faker • A Shopify development tool for generating dummy store data.