Getting started

Getting started with theme App extensions

You can start building theme App extensions with SHOPLINE CLI .

SHOPLINE validates theme App extensions when you push a draft version. If the App's content exceeds enforced limits on theme app extensions, then the extension fails validation and doesn't update.

What you'll learn

After you've finished this tutorial, you'll have accomplished the following tasks:

Requirements

1. Create a app

Enter SHOPLINE open platform, if you have registered on this platform before, you can log in with your account number and password. If you have not registered, you can register on the platform.
Please refer to how to create an application

2. Build theme App expansion locally​

Use the SHOPLINE CLI to create a theme App to extend the directory structure:

  1. Open a terminal and use the cd command to go into your project root directory:
cd my-app-directory
  1. Log in to your store account:
shopline login --store <STORE_DOMAIN>
  1. Create a theme app extension:
shopline extension create
tip

You can use the --name parameter to specify or create a directory with another name, the default is theme-app-extension

3. Push your theme App extension to a draft version

Use the shopline extension push command to create a draft version on the platform.

shopline extension push

4. Test your changes

Verify that your application looks and behaves correctly by testing your changes in the online store.

  1. In your online store, go to a theme and navigate to the theme editor
  2. The following steps are followed.
    • Add app block
    • Turn on app embed block
  3. Verify that the application behaves as expected.

5. Publish theme App extension

After your theme app extension is ready for use, you can push the latest code and make the App extension public.

  1. Push extension to SHOPLINE
shopline extension push

After the push is successful, you will see a link to go to the open platform to create a version in your terminal. Click the link to go to the open platform to create a version.

✔ Pushed theme-app-extension to a draft on 2024-01-31 18:31:49.
✨ Visit https://developer.myshopline.com/app/edit-extension/your-app-id/your-extension-id to version and publish your extension.
  1. Create and publish a version of your theme app extension in the SHOPLINE developer center by following the steps:
    1. Go to Apps and click your target app name.
    2. Go to App extensions and click the name of your app extension.
    3. Click Create a version and choose a version type (minor version or major version) that you want to create on the pop-up window.
    4. Click Add.
    5. Click Publish under Operation.
    6. Click Publish on the pop-up window to confirm.
Was this article helpful to you?