podupu/sanity-commercelayer

Commerce Layer Starter

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
  • ⚙️ Installation guide
  • ⬇️ Import test studio content
  • ⬇️ Seed Commerce Layer data
• ⚠️ Important notes
• 🚀 Production environment variables
• Contributors guide
• Need help?
• License

Starter features

• An ecommerce storefront built with Nextjs, Commerce Layer react components library, and Tailwind CSS.
• International shopping capabilities powered by Commerce Layer APIs.
• PSD2-compliant and production-ready checkout functionality powered by Commerce Layer React Checkout Application.
• Micro CLI seeder to import Commerce Layer data.
• Structured content on Sanity CMS.
• Localization support.
• Deployment configuration to Netlify.

Getting started

The quickest way to get up and running is to go to https://www.sanity.io/create?template=commercelayer/sanity-template-commercelayer, create a new project (following the instructions on Sanity), and read the important notes and production ENV guidelines.

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:

• Your project ID, dataset, and token from manage.sanity.io.
• Your Sales channels application client ID and base endpoint from Commerce Layer (you can create this automatically by following our onboarding guide or manually on the Commerce Layer dashboard).

3. Run the command below to install the necessary dependencies of your project:

npm install && cd /studio && sanity install

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

5. 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.

2. Run the command below in the /studio directory to import the data.ndjson file in the extracted folder.

sanity dataset import ../.sanity-template/data/<name of extracted folder>/data.ndjson <your_dataset>

3. Check the studio now on localhost:3333 to preview the imported content.

⬇️ Seed Commerce Layer data

1. Create a free Commerce Layer account. If you already have an account, kindly skip to Step 3.

2. Create a new organization or follow the onboarding tutorial guide.

3. Create a new Integrations application with Name set to CLI and Role set to admin.

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

5. Install the Commerce Layer CLI which is available as an npm package or yarn package using the command below:

// npm
npm install -g @commercelayer/cli

//yarn
yarn global add @commercelayer/cli

6. Log into your application via the CLI using the previously created CLI credentials like so:

commercelayer applications:login -o <organizationSlug> -i <clientId> -s <clientSecret> -a <applicationAlias>

7. Install the seeder plugin using the command below:

commercelayer plugins:install seeder

8. Run the command below to import three demo markets (UK, USA, and Europe), a set of product SKUs, related price lists, related prices, stock locations, and inventory into your organization using the multi_market business model.

commercelayer seed -b multi_market

9. To see the commands for other seeder options, type the command below:

commercelayer --help

⚠️ Important notes

The Sanity content data includes a collection of sample countries, products, variants, sizes, taxons, taxonomies, catalogs, and product images created during development. To get an access token we fetch the scope (market ID) from the Market Id attribute set in the Sanity country schema.

So, when you seed your Commerce Layer organization, some markets will be created which will have a different Market ID from the one set in Sanity. So you need to fetch the valid market scope's number (from the sales channel tab in the Commerce Layer dashboard) and update the appropriate country model in Sanity. For example, the Europe Market on Commerce Layer and Italy country model on Sanity. Failure to do this will result in an invalid scope authentication error when you try to access your application.

Also, you must access the application using the right locale slug for the country you have configured like so localhost:3000/it/it-it or localhost:3000/us/en-us. If you want to set up other countries, then create a market for it on Commerce Layer alongside the associated resources and update the Market ID on Sanity as you earlier did.

Ideally, you would want to add your content data and set up Commerce Layer manually based on your use cases. To ensure the starter runs smoothly, ensure to update the market ID attribute, create a product, and link to variant(s) on Sanity and create a market associated with a stock location, stock item, price list, price, and SKU in Commerce Layer.

🚀 Production Environment Variables

When you deploy your project to Netlify, you need to update the SANITY_PROJECT_ID, CL_CLIENT_ID, and CL_ENDPOINT environment variables to valid credentials for the applications in use. You can update this in the netlify.toml file as seen below. For security reasons, you should add the environment variables in the Netlify dashboard during build time.

[build.environment]
  NEXT_SERVERLESS = "true"
  SANITY_PROJECT_ID="xyz7gbab"
  SANITY_DATASET="production"
  BUILD_LANGUAGES = "en-US,it-IT"
  BUILD_CMS = "sanity"
  CL_CLIENT_ID = "HOpqt0R5oIDG8BlttE4idgGQkR6PeOkBCNnQhp-nvGk"
  CL_ENDPOINT = "https://demo.commercelayer.io"

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

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

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

Need help?

1. Join Commerce Layer's Slack community.

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? Then you should read this article.