Once your custom components are developed and tested locally, you’re ready to deploy them to your production checkout environment.

Before you continue, please check your Node.js version:
  1. Open Visual Studio Code (VS Code).
  2. Open the Terminal (you can use the shortcut: Ctrl + ~ or go to Terminal > New Terminal from the top menu).
  3. Type the following command and press Enter:
node -v
  1. Make sure it shows v22.x.x.
  • If it’s a different version, you’ll need to update Node.js to version 22 before continuing.

Step 1: Requirements & Configuration

Before deploying, make sure you have the following configured correctly:

ollie.json

Ensure that the values in your ollie.json file match those configured in Ollie’s Admin Panel.

  • storeId
  • versionId

​
Component Setup

  • Each component must have its own meta.json file.
  • The meta.json should include the component ID that was generated when the component was created in the Ollie Admin.
  • Make sure your components are already set up in the Ollie Admin.

Step 2: Authentication

To authenticate before deploying:

npx @ollie-shop/cli login
Login via GitHub when prompted.

Step 3: Submitting via PreviewJS

Once authenticated:

  • In PreviewJS, click the Deployment button from the top menu.
  • Double-check the component ID to ensure accuracy.
  • Click Deploy.

If the configuration box disappears, the deployment was successful.