Skip to content

Update README.md of all projects #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pfferrari wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update README.md of all projects #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
104792e
feat: update README.md of all projects
pfferrari Sep 30, 2026
4cf5008
chore: remove old/unwanted docs links
pfferrari Oct 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,16 @@ Here are the parent categories of the examples in this repository for easy navig

## Get Started with Commerce Layer

- [All Developer Resources](https://commercelayer.io/developers)
- [All Developer Resources](https://commercelayer.io/resources)
- [Commerce Layer Documentation](https://docs.commercelayer.io)
- [Commerce Layer API Reference](https://docs.commercelayer.io/core/v/api-reference/)
- [Commerce Layer Core Concepts](https://commercelayer.io/docs/core-concepts)
- [Commerce Layer Data Model](https://commercelayer.io/docs/data-model)
- [Commerce Layer API Reference](https://docs.commercelayer.io/core-api-reference)
- [Commerce Layer Core Concepts](https://docs.commercelayer.io/core)
- [Commerce Layer Blog](https://commercelayer.io/blog)
- [Commerce Layer Case Studies](https://commercelayer.io/customers)

## Contributors Guide

1. Fork [this repository](https://github.com/commercelayer/examples) (learn how to do this [here](https://help.github.com/articles/fork-a-repo)).
1. Fork [this repository](https://github.com/commercelayer/examples) (learn how to do this [here](https://docs.github.com/en/pull-requests/how-tos/work-with-forks/fork-a-repo)).

2. Clone the forked repository like so:

Expand All @@ -51,13 +50,13 @@ git clone https://github.com/<your username>/examples.git && cd examples

6. Add the new example to the list in the category's `README.md` file following the same format as the other examples (follow the sequential alphabetical order by name as seen in your local computer).

7. Make your changes and create a pull request ([learn how to do this](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)).
7. Make your changes and create a pull request ([learn how to do this](https://docs.github.com/en/pull-requests/how-tos/create-pull-requests/creating-a-pull-request)).

8. Someone will attend to your pull request, provide some feedback, and eventually merge the PR!

> **Note**
>
> This repository will include examples that follow all the best practices we are following in all our [other public OSS projects](https://commercelayer.io/developers). If you decide to contribute, someone will review and provide some feedback. Thank you!
> This repository will include examples that follow all the best practices we are following in all our [other public OSS projects](https://github.com/commercelayer). If you decide to contribute, someone will review and provide some feedback. Thank you!

## Need Help?

Expand All @@ -76,6 +75,6 @@ This repository is published under the [MIT](LICENSE) license.
![Commerce Layer Logo](/.assets/cl-light.svg#gh-dark-mode-only)
![Commerce Layer Logo](/.assets/cl-dark.svg#gh-light-mode-only)

<p><a href="https://commercelayer.io/why" target="_blank" rel="noopener noreferrer">Commerce Layer</a> 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 <a href="https://docs.commercelayer.io" target="_blank" rel="noopener noreferrer">secure API</a>.</p>
<p><a href="https://commercelayer.io/vision" target="_blank" rel="noopener noreferrer">Commerce Layer</a> 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 <a href="https://docs.commercelayer.io" target="_blank" rel="noopener noreferrer">secure API</a>.</p>

</div>
28 changes: 14 additions & 14 deletions authentication/nextjs-auth0-sso/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# SSO with Nextjs, Auth0, and Commerce Layer

This example shows you how to integrate [Auth0 Nextjs SDK](https://github.com/auth0/nextjs-auth0) into a Nextjs application created using [create-next-app](https://nextjs.org/docs/api-reference/create-next-app). You can use it as a reference to build an SSO flow with Commerce Layer. The sample is a companion to the [Auth0 Nextjs SDK Quickstart](https://auth0.com/docs/quickstart/webapp/nextjs). To get started, kindly read [this comprehensive tutorial](https://commercelayer.io/blog/single-sign-on-with-commerce-layer-using-next-js-and-auth0) on our blog.
This example shows you how to integrate [Auth0 Nextjs SDK](https://github.com/auth0/nextjs-auth0) into a Nextjs application created using [create-next-app](https://nextjs.org/docs/app/api-reference/cli/create-next-app). You can use it as a reference to build an SSO flow with Commerce Layer. The sample is a companion to the [Auth0 Nextjs SDK Quickstart](https://auth0.com/docs/quickstart/webapp/nextjs). To get started, kindly read [this comprehensive tutorial](https://commercelayer.io/blog/single-sign-on-with-commerce-layer-using-next-js-and-auth0) on our blog.

---

## Quick start guide

This sample covers the following use cases:

- [Login](https://github.com/commercelayer/sample-nextjs-auth0-sso/blob/main/components/NavBar.jsx#L61-L67)
- [Logout](https://github.com/commercelayer/sample-nextjs-auth0-sso/blob/main/components/NavBar.jsx#L93-L95)
- [Showing the user profile](https://github.com/commercelayer/sample-nextjs-auth0-sso/blob/main/pages/profile.jsx)
- [Protecting client-side rendered pages](https://github.com/commercelayer/sample-nextjs-auth0-sso/blob/main/pages/profile.jsx#L43-L46)
- [Showing Commerce Layer product and price on the homepage](https://github.com/commercelayer/sample-nextjs-auth0-sso/blob/main/components/Content.jsx)
- [Showing Commerce Layer user's order history](https://github.com/commercelayer/sample-nextjs-auth0-sso/blob/main/pages/orders.jsx)
- [Login](./components/NavBar.jsx)
- [Logout](./components/NavBar.jsx)
- [Showing the user profile](./app/profile/page.jsx)
- [Protecting client-side rendered pages](./app/csr/page.jsx)
- [Showing Commerce Layer product and price on the homepage](./components/Content.jsx)
- [Showing Commerce Layer user's order history](./app/orders/page.jsx)

```mermaid
sequenceDiagram
Expand Down Expand Up @@ -60,12 +60,12 @@ pnpm install

This example uses Auth0, an easy-to-implement, adaptable authentication and authorization platform. Auth0 helps you to:

- Add authentication with [multiple sources](https://auth0.com/docs/identityproviders), either social identity providers such as Google, Facebook, Microsoft Account, LinkedIn, GitHub, Twitter, Box, Salesforce (amongst others), or enterprise identity systems like Windows Azure AD, Google Apps, Active Directory, ADFS, or any SAML Identity Provider.
- Add authentication through more traditional [username/password databases](https://auth0.com/docs/connections/database/custom-db).
- Add support for [linking different user accounts](https://auth0.com/docs/users/user-account-linking) with the same user.
- Support for generating signed [JSON Web Tokens](https://auth0.com/docs/tokens/json-web-tokens) to call your APIs and flow the user identity securely.
- Add authentication with [multiple sources](https://auth0.com/docs/authenticate/identity-providers), either social identity providers such as Google, Facebook, Microsoft Account, LinkedIn, GitHub, Twitter, Box, Salesforce (amongst others), or enterprise identity systems like Windows Azure AD, Google Apps, Active Directory, ADFS, or any SAML Identity Provider.
- Add authentication through more traditional [username/password databases](https://auth0.com/docs/authenticate/database-connections/custom-db).
- Add support for [linking different user accounts](https://auth0.com/docs/manage-users/user-accounts/user-account-linking) with the same user.
- Support for generating signed [JSON Web Tokens](https://auth0.com/docs/secure/tokens/json-web-tokens) to call your APIs and flow the user identity securely.
- Analytics of how, when, and where users are logging in.
- Pull data from other sources and add it to the user profile through [JavaScript rules](https://auth0.com/docs/rules).
- Pull data from other sources and add it to the user profile through [JavaScript rules](https://auth0.com/docs/customize/rules).

To get started, create a free Commerce Layer account like so:

Expand All @@ -83,7 +83,7 @@ Also, create a free Auth0 account like so:

The project needs to be configured with your Auth0 domain, client ID, and client secret for the authentication flow to work.

To do that, first copy `.env.local.example` into a new file in the same folder called `.env.local`, and replace the values with your own Auth0 application credentials (more info about loading environmental variables in Nextjs [here](https://nextjs.org/docs/basic-features/environment-variables)):
To do that, first copy `.env.local.example` into a new file in the same folder called `.env.local`, and replace the values with your own Auth0 application credentials (more info about loading environmental variables in Nextjs [here](https://nextjs.org/docs/pages/guides/environment-variables)):

```sh
# A long secret value used to encrypt the session cookie
Expand Down Expand Up @@ -114,7 +114,7 @@ AUTH0_M2M_CLIENT_SECRET='YOUR_AUTH0_M2M_CLIENT_SECRET'

#### Commerce Layer

You also need to use a [sales channel](https://docs.commercelayer.io/core/applications#sales-channel) and an [integration](https://docs.commercelayer.io/core/applications#integration) application on Commerce Layer. Add to `.env.local` the following variables setting your applications' credentials and market information. Note that the organization slug and endpoint are automatically inferred from the access token:
You also need to use a [sales channel](https://docs.commercelayer.io/core/api-credentials#sales-channel) and an [integration](https://docs.commercelayer.io/core/api-credentials#integration) application on Commerce Layer. Add to `.env.local` the following variables setting your applications' credentials and market information. Note that the organization slug and endpoint are automatically inferred from the access token:

```sh
CL_INTEGRATION_CLIENT_ID='YOU INTEGRATION CLIENT ID'
Expand Down
Loading