Skip to content

Latest commit

 

History

History
69 lines (42 loc) · 3.77 KB

README.md

File metadata and controls

69 lines (42 loc) · 3.77 KB
Raw

Dashboard apps

Any Commerce Layer account comes with the hosted version of a full set of Dashboard applications, automatically enabled for admin users. An admin can then enable one or more apps for other organization members giving each member full or read-only access. For an updated list of the available applications, check the ./apps folder of this repository or read more here.

It's possible to clone this repository and add one or more apps to your Dashboard, in order to customize every part of the code and start using your own self-hosted version. For more information on how to do it, read more here.

Table of contents

Getting started

You need a local Node.js (version 20+) environment and some React knowledge to customize the app code.

  1. Create a new repository from this template (if you want to contribute you can start from a fork instead).

  2. Clone the newly created repository like so:

git clone https://github.com/<your username>/dashboard-apps.git && cd dashboard-apps
  1. Install dependencies and run the development server:
pnpm install
pnpm dev

  1. The "router" app will run in development mode at http://localhost:5173. The "router" app is the orchestrator for all other applications, and it is available only for local development as an alternative to the Dashboard.
    In order to authenticate the app, you need to add an integration access token as URL query param. Example: http://localhost:5173/?accessToken=<integration-token-for-local-dev>. That access token is only required (and will work only) for development mode. In production mode, the Commerce Layer Dashboard will generate a valid access token, based on the current user.

  2. Modify any application you need to satisfy your requirements. Applications are stored inside the ./apps folder. All our Dashboard apps are built using a shared component library @commercelayer/app-elements. You can browse the official documentation to discover more about this topic.

  3. Build all applications into the ./dist folder:

pnpm build:apps
  1. Deploy the forked repository to your preferred hosting service. You can deploy with one click below:

Deploy to Netlify Deploy to Vercel

  1. Create a custom app in the Commerce Layer Dashboard.

Running on Windows

Read more

Need help?

  1. Join Commerce Layer's Slack community.

  2. Create an issue in this repository.

  3. Ping us on X.

License

This repository is published under the MIT license