Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/commercelayer/app-orders
Commerce Layer application for managing orders.
https://github.com/commercelayer/app-orders
admin-apps commercelayer composable-commerce dashboard-apps ecommerce oms react
Last synced: 27 days ago
JSON representation
Commerce Layer application for managing orders.
- Host: GitHub
- URL: https://github.com/commercelayer/app-orders
- Owner: commercelayer
- License: mit
- Created: 2023-01-24T09:44:26.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-23T15:37:17.000Z (5 months ago)
- Last Synced: 2024-07-24T18:17:19.533Z (5 months ago)
- Topics: admin-apps, commercelayer, composable-commerce, dashboard-apps, ecommerce, oms, react
- Language: TypeScript
- Homepage:
- Size: 1.61 MB
- Stars: 0
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> [!WARNING]
> This repository is no longer maitained. We moved all our Dashboard applications to a brand new [dashboard-apps](https://github.com/commercelayer/dashboard-apps) monorepo. This allows you to run them all locally effortlessly.
# App Orders
Commerce Layer application for managing orders.
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](#getting-started)
- [Running on Windows](#running-on-windows)
- [Help and support](#need-help)
- [License](#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](https://github.com/commercelayer/app-orders) (you can learn how to do this [here](https://help.github.com/articles/fork-a-repo)).
2. Clone the forked repository like so:
```bash
git clone https://github.com//app-orders.git && cd app-orders
```
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=`.
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](https://github.com/commercelayer/app-elements).
You can browse the [official documentation](https://github.com/commercelayer/app-elements) to discover more about this topic.
7. Deploy the forked repository to your preferred hosting service. You can deploy with one click below:
[
](https://app.netlify.com/start/deploy?repository=https://github.com/commercelayer/app-orders#PUBLIC_SELF_HOSTED_SLUG) [
](https://vercel.com/new/clone?repository-url=https://github.com/commercelayer/app-orders&build-command=pnpm%20build&output-directory=packages%2Fapp%2Fdist&env=PUBLIC_SELF_HOSTED_SLUG&envDescription=your%20organization%20slug)
8. Complete the configuration in the Dashboard hub by setting your app URL.
## Running on Windows
[Read more](https://github.com/commercelayer/.github/blob/main/PNPM_ON_WINDOWS.md)
## Need help?
1. Join [Commerce Layer's Slack community](https://slack.commercelayer.app).
2. Create an [issue](https://github.com/commercelayer/app-orders/issues) in this repository.
3. Ping us [on Twitter](https://twitter.com/commercelayer).
## License
This repository is published under the [MIT](LICENSE) license