Get Started
Deployment
Publish and integrate your custom checkout components into your live Ollie checkout.
Once your custom components are developed and tested locally, you’re ready to deploy them to your production checkout environment.
Before continuing, make sure you’re using Node.js v22 in your VS Code environment.
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:
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.