Installing an Open Source Checkout
You can create unique shopping experiences that fit the look and feel of a store's brand using custom checkouts. This article outlines how to package a custom checkout file and install a custom checkout using the control panel.
Custom checkouts must have a single JS loader file. The first step to using a custom checkout is generating this file. The loader file must be responsible for the following:
- Loading all the required assets, including all CSS files, no matter the location
- Running the app
If you wish to customize a checkout, enter your CSS into the optimized-checkout.scss (opens in a new tab) in Cornerstone or the scss folder (opens in a new tab) in checkout.js. We suggest moving content from "optimized-checkout.scss to the scss folder or vice-versa to ensure a single source of truth for handling styles.
Note: "optimized-checkout.scss" will always override the CSS rules defined in checkout-js.
If using Open Source Checkout (opens in a new tab), you can generate the loader file by following these steps:
- Fork and clone checkout-js (opens in a new tab); then, install dependencies.
# Clone the repo git clone https://github.com/bigcommerce/checkout-js # Install dependencies cd checkout-js npm ci
- Start webpack in watch mode and launch the dev server.
npm run dev & npm run dev:server
- Open your browser and navigate to
http://127.0.0.1:8080/to confirm the dev server is running. You should see content from
- To serve files over HTTPS, install an SSL on your development machine, or use ngrok (opens in a new tab).
When using Open Source Checkout to view changes and test implementations through the UI, deploy, and install the custom checkout. Checkout-JS is a reference implementation of Checkout SDK; therefore, changes to your loader file are unnecessary. For more details on installing the Checkout JS SDK, see the Checkout SDK Tutorial.
You'll need to host the custom checkout file online so the store can serve it. You can use a hosting service, such as Amazon S3 (opens in a new tab). Using an external host gives you the freedom to automate the build process if you wish and push updates automatically from your local machine. Or you can host it on your store using WebDAV.
The steps to host a custom checkout on BigCommerce are below:
- Use WebDAV to upload a custom checkout. For details, see Use WebDAV (opens in a new tab) to upload the checkout-loader.js file.
- Install custom checkout using the control panel (opens in a new tab) or use the Update Checkout Settings (opens in a new tab) endpoint to install the loader file.