Commerce Layer Starter

A multi-country ecommerce starter that features the sanity studio built with Commerce Layer, Next.js, and deployed to Netlify.

What is Commerce Layer?

Commerce Layer is a multi-market commerce API and order management system that lets you add global shopping capabilities to any website, mobile app, chatbot, wearable, voice, or IoT device, with ease. Compose your stack with the best-of-breed tools you already mastered and love. Make any experience shoppable, anywhere, through a blazing-fast, enterprise-grade, and secure API.

Table of contents

Starter features

Getting started

The quickest way to get up and running is to go to https://www.sanity.io/create?template=commercelayer/sanity-template-commercelayer and create a new project by following the instructions on Sanity.

Alternatively, you can clone this repository, configure the starter, import the dataset into your Sanity studio, import some test data into your Commerce Layer organization, and deploy your application.

⚙️ Installation guide

  1. Clone this repository (learn how to do this).

  2. Rename the /env.example file to .env and add the following:

  1. Run the command below to install the necessary dependencies of your project:
npm install && cd /studio && sanity install

  1. Add your projectTitle, projectId, and dataset in /studio/sanity.json.

  2. Run the command below to start the development server:

npm run dev

This will run the frontend at localhost:3000 and studio at localhost:3333.

⬇️ Import test studio content

If you set up your project from the starters page on Sanity, you should skip this step as Sanity will automatically add the dataset’s content.

  1. Extract the production.tar.gz file in /.sanity-template/data directory using the command below:
tar -xf production.tar.gz

The extracted folder name should look like production-export-2021-02-26t14-15-56-557z.

  1. Run the command below in /studio to import the data.ndjson file in the extracted folder.
sanity dataset import ../.sanity-template/data/<name of extracted folder>/data.ndjson <your_dataset>
  1. Check the frontend and studio now to preview the imported content.

⬇️ Seed Commerce Layer data

  1. Create a Commerce Layer account.

  2. Create a new organization.

  3. Create a new application in Settings > Applications with Kind set to integration, and Role set to admin.

  4. In your newly created application, copy your Client ID and Client Secret.

  5. Install the Commerce Layer Seeder which is available as an npm package:

// npm
npm install -g @commercelayer/commercelayer-seeder-cli

// yarn
yarn global add @commercelayer/commercelayer-seeder-cli
  1. Run the command below to import a set of products, related prices, and inventory into your organization.
commercelayer-seeder -i <your-client-id> -s <your-client-secret> -e https://<yourdomain>.commercelayer.io
  1. To see the commands for other seeder options, type the command below:
commercelayer-seeder --help

Contributors guide

  1. Fork this repository (learn how to do this here).

  2. Clone the forked repository like so:

git clone https://github.com/<your username>/sanity-template-commercelayer.git && cd sanity-template-commercelayer

  1. Make your changes and create a pull request (learn how to do this).

  2. Someone will attend to your pull request and provide some feedback.

Need help?

  1. Request an invite to join Commerce Layer’s Slack community (kindly scroll down to the bottom of the page).

  2. Create an issue in this repository.

  3. Ping us on Twitter.

License

This repository is published under the MIT license.

Want to learn more about how we built this starter and how you can build yours? Sign up for our newsletter to get notified once we publish the article.

GitHub

View Github