commercelayer / app-inventory

Commerce Layer application for managing inventory.

App Inventory

Commerce Layer application for managing Inventory.

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-inventory.git && cd app-inventory

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

app-inventory's Issues

Show `home` counters

Describe the solution you'd like

Add home counters showing the number of stock items for each stock locations without relying on the API include of stock_items resource.

Hide from `Pick a SKU` page the currently selected SKU

Is your feature request related to a problem? Please describe

Actually when you open the Pick a SKU page after having previously selected a SKU to change it and select a new one you can see in the list also the currently selected SKU. It should not be visible here to enforce the UX and avoid misunderstandings.
CC: @malessani @simonesusini

Describe the solution you'd like

As already tested in other apps it is possible to improve the filters instructions that are used to generate the FilteredList component used in the Pick a SKU page to add a hidden filter dedicated to hide from the SKU selectable items the one the is currently selected.

Are you able to assist to bring the feature to reality?

yes, I can

Add `stock items list` page

Describe the solution you'd like

• Add stock items list page to show a searchable list of stock items filtered by the id of clicked stock location.
• Show at the bottom of stock items' list item a badge showing the count of reserved items.

Add `home` page

Describe the solution you'd like

• Add home page to show a searchable list of current organization's stock locations.
• Once a stock locations is clicked we should reach a page showing stock location's searchable stock items.