Warning

This repository is no longer maitained. We moved all our Dashboard applications to a brand new dashboard-apps monorepo. This allows you to run them all locally effortlessly.

App Exports

Commerce Layer application for exporting resources.

Any Commerce Layer account comes with a hosted version of this application, as part of the Dashboard hub, and it is automatically enabled for admin users. An admin can then enable the app for other organization members giving each member full or read-only access.

It's possible to fork this app and add it to your Dashboard hub, in order to customize every part of the code and start using your own and self-hosted version.

Table of contents

• Getting started
• Running on Windows
• Help and support
• License

Getting started

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

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

2. Clone the forked repository like so:

git clone https://github.com/<your username>/app-exports.git && cd app-exports

3. Set your environment by creating a new /src/app/.env.local file starting from /src/app/.env (not required for local development).

4. Install dependencies and run the development server:

pnpm install
pnpm dev

5. The app will run in development mode at http://localhost:5173/. 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 hub will generate a valid access token, based on the current user.

6. Modify the app to satisfy your requirements. 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.

7. Deploy the forked repository to your preferred hosting service. You can deploy with one click below:

8. Complete the configuration in the Dashboard hub by setting your app URL.

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

License

This repository is published under the MIT license