ShopBase Developers
  • Getting started
  • Build An App
    • Making your first request
      • Authentication
        • Public apps
        • Private apps
        • OAuth
        • API access scopes
      • Rest API References
        • Rate limits
      • Using webhooks
        • Webhook events and topics
      • Response status codes
    • How to submit an app to ShopBase App Store
    • Getting your app approved
      • App requirements
      • Testing your app
      • Submitting your app
      • The review process
  • BUILD A THEME
    • Getting started building themes
    • Theme development resources
      • Connect to your store & start developing
      • Theme structure
      • Theme object, methods, and props
      • Theme editor
        • How to update configure for theme editor
    • How to submit a theme to ShopBase Theme Store
    • Storefront SDK
  • Test and Debug app
    • Debug apps with Postman
  • Tutorial
    • Manage orders and shipping
      • Manage orders with the REST Admin API
        • Transaction
        • Order
      • Edit an existing order with the Admin API
      • Manage fulfillments with Fulfillment and FulfillmentService resources
      • Get a country field using Admin API
  • Integrate a payment gateway
    • How to create your payment gateway on ShopBase
    • Technical Specifications
Powered by GitBook
On this page
  • ShopBase Theme CLI Overview
  • How to install ShopBase Theme CLI
  • Starter theme

Was this helpful?

  1. BUILD A THEME

Theme development resources

ShopBase Theme CLI Overview

ShopBase Theme CLI helps you develop themes for ShopBase easily.

How to install ShopBase Theme CLI

Node Version Requirement ShopBase Theme CLI requires Node.js version 10.13.0 or above. You can manage multiple versions of Node on the same machine with nvm or nvm-windows

To install the new package, use one of the following commands. You need administrator privileges to execute these unless npm was installed on your system through a Node.js version manager (e.g. n or nvm).

npm install -g @shopbase-theme/cli
# OR
yarn global add @shopbase-theme/cli

Starter theme

The quickest way to get up and running with a workspace for building themes is to use the official starter theme

To get started, you need to log in to your Partner account (make sure you request to create partner account here)

shopbase-theme auth:login

After authenticated by using your email & password, you can use the following command to create a new theme.

shopbase-theme create new-theme

Note: new-theme is a handle of a theme, you may change theme name in ShopBase Partner Dashboard

All source code is cloned from starter-theme repo. We recommend starting with this starter theme.

To view all available command, use the help command

shopbase-theme help
PreviousGetting started building themesNextConnect to your store & start developing

Last updated 4 years ago

Was this helpful?