easyPoints

# Getting Started

WARNING

The EasyPoints integration guide assumes intermediate level knowledge of Liquid, HTML, CSS, and JavaScript. If you are totally new to Shopify themes, it might be better to contact us at easypoints.jp (opens new window) for a custom integration built by our in-house engineers.

# Requirements

# Setup

TIP

If you've already got your own theme development flow then you can skip straight to the actual theme integration found -link-here-

To make Shopify theme development easier we'll guide you through a few steps to start developing your theme locally.

Alternatively but not recommended you can also simply use Shopify's built in theme editor.

# Shopify Private App

We’ll create a Shopify private app to get an API key that we require for our configuration later on. The API key will allow Theme Kit to talk to and access your store, as well as its theme files.

To do so, we need to log into the Shopify store, and create a private app.

In the Shopify Admin, go to “Apps” and click on “Manage private apps.” If you want to work with private apps, then > you need to first enable the private app development setting from the “Manage private apps” in admin page. Only the store owner can enable private app development. From there, click “Create > a new private app.” You’ll need to provide a title—I usually provide the name of the client and environment for clarity. Make sure to set the permissions of “Theme templates and theme assets” to have “Read and write access” in order to generate the appropriate API credentials, then click “Save.”

-- Shopify blog (opens new window)

# Theme ID

# Theme Kit

Last but not least installing Theme Kit, and the reason why we had to create a Shopify private app and get your theme id. Theme Kit is a command line tool for shopify themes to easily download, deploy and develop your themes.

To install Theme Kit (opens new window) please follow the installation guide on the official documentation (opens new window) page. Verify if Theme Kit was successfully installed using theme version

> theme version
ThemeKit 1.1.2 darwin/amd64

Now we're ready to setup Theme Kit for your Shopify theme!

# Using Theme Kit

Before we start you can find the in-depth usage documentation of Theme Kit here (opens new window).

Once you've got your API Key, Theme ID and Theme Kit installed, to start using it for theme development it requires us to setup some local environment configuration.

First we'll create a new folder for your theme:

> mkdir [your-theme-name]

Then, go into that directory where we'll create a config.yml file

> cd [your-theme-name]

← Integrating EasyPoints →