{"id":19622234,"url":"https://github.com/commercetools/commercetools-instore-center","last_synced_at":"2025-04-28T03:32:28.747Z","repository":{"id":145046685,"uuid":"75094638","full_name":"commercetools/commercetools-instore-center","owner":"commercetools","description":null,"archived":false,"fork":false,"pushed_at":"2023-10-23T21:52:39.000Z","size":1231,"stargazers_count":7,"open_issues_count":3,"forks_count":2,"subscribers_count":79,"default_branch":"master","last_synced_at":"2025-04-20T15:17:54.902Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/commercetools.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-11-29T15:29:01.000Z","updated_at":"2024-05-02T20:41:02.000Z","dependencies_parsed_at":null,"dependency_job_id":"8f6d8ac3-d552-4def-a0f8-0355988a100d","html_url":"https://github.com/commercetools/commercetools-instore-center","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commercetools%2Fcommercetools-instore-center","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commercetools%2Fcommercetools-instore-center/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commercetools%2Fcommercetools-instore-center/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commercetools%2Fcommercetools-instore-center/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/commercetools","download_url":"https://codeload.github.com/commercetools/commercetools-instore-center/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251246394,"owners_count":21558762,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T11:26:44.393Z","updated_at":"2025-04-28T03:32:28.741Z","avatar_url":"https://github.com/commercetools.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"InStore\n==================\n\n[![Build Status](https://api.travis-ci.com/commercetools/commercetools-instore-center.svg?token=G3zYkVxzDwVADM6vtKUL\u0026branch=master)](https://travis-ci.com/commercetools/commercetools-instore-center)\n\n## Synopsis\n\nThe Commercetools in store app allows customers to manage order reservations from the Sunrise mobile app, reviewing customer insights and checking inventory entries for different channels.\n\n## Motivation\n\nThe motivation of this app is to allow sales force to engage customers and improving the shopping experience by using the information already existing in the Commercetools platform and machine learning features. and machine learning features.\n\nIts current incarnation targets the staff of a physical store that is part of a 'click and collect' fulfilment offering. \n\n## Installation\n\nInstall local dependencies of the implementation:\n```\nnpm install\n```\n\nIn addition you need a commercetools platform project with suitable data structures:\n * There need to be channels set up that have the ```ProductDistribution``` and the ```InventorySupply``` roles set. \n * The in-store UI only shows orders that have \n   1. a custom Boolean field ```isReservation``` set.\n   2. the correct store set as the ```supplyChannel``` of the order line items to be picked up. \n\nThis is the type of data generated by the SUNRISE demo storefront, so you can use the [SUNRISE example data](https://github.com/commercetools/commercetools-sunrise-data)  and the [SUNRISE Java Storefront](https://github.com/commercetools/commercetools-sunrise-java-starter) to set up the data and a storefront to easily create the reservation orders. \n\n## Launch and Configuration\n\nConfiguration files for the commercetools API and client credentials can be found in the [src/config/env/](src/config/env/) folder. \nThey override the data in ```default.json```.  API defaults to the EU CTP at ```api.sphere.io```.\n \nYou need to set your project's credentials there.  \nThe best way is to create a specific client ID for this app. \n\n\u003c!--\n\nXXX THERE ARE DYSFUNCITONAL ARTIFACTS FOR THIS IN THE CODE:\n\nThe ```development``` environment can be configured ad-hoc with the following environment variables:\n * ```CTP_PROJECT_KEY```\n * ```CTP_CLIENT_IDY```\n * ```CTP_CLIENT_SECRET```\n--\u003e\n\nThe 'default' build command launches a local server with the ```development``` configuration:\n```\nnpm run-script gulp\n```\n\nThe production configuration can be launched as:\n```\nnpm run-script production\n```\n\nThe local address of both is [http://localhost:3000](http://localhost:3000)\n\n## Usage\n\n### Dashboard\n\n![dashboard](https://user-images.githubusercontent.com/576460/30800463-5c73f3b2-a1e0-11e7-8e33-6596a4b411ea.jpg)\n\nAllows you to briefly display the sales, orders, customers and stocks for the selected store. The dashboard also allows the user to filter by dates in order to get the required info based on a desired period of time.\n\n\n### [Inventories](https://github.com/commercetools/commercetools-instore-center/blob/documentation/docs/inventories.md)\n\n![inventories](https://user-images.githubusercontent.com/576460/30800470-607261f6-a1e0-11e7-9912-2595e7a1b699.jpg)\n\nIn the inventories section, products of the selected store are displayed indicating the available quantity. You can access the product details from this list by clicking on the row and also check the availability of the product in any other store sorted by distance.\n\nWhen clicking on the check button, a new window will be shown displaying the availability of the selected product in the different channels and sorting the results by distance from the store (from nearest to farthest).\n\n![availability](https://user-images.githubusercontent.com/576460/30800724-3b31fea0-a1e1-11e7-8485-dd929f6f3e60.jpg)\n\nThe following image shows how the product details page is displayed when clicking on the product row from the inventory list where the user cat get some details from the product and some related products that can be recommended to the customer.\n\n![inventoriesdetail](https://user-images.githubusercontent.com/576460/30802693-a0d31824-a1e7-11e7-8609-472426a93c6b.jpg)\n\n\n### [Orders](https://github.com/commercetools/commercetools-instore-center/blob/documentation/docs/orders.md)\n\n![orders](https://user-images.githubusercontent.com/576460/30800482-6963d4ca-a1e0-11e7-83f9-840fb873fb03.jpg)\n\nThis section shows the list of orders that has been processed by the Sunrise mobile app. In this section the user can confirm the order and process it whenever a customer comes to the store to pick up the items. The user can also cancel an order if needed. This actions can be performed directly on the list by clicking on the *Process* button or in the order details page which is detailed in the following screenshot:\n\n![orderdetail](https://user-images.githubusercontent.com/576460/30800883-bedc39e6-a1e1-11e7-815d-56ad2afc3d66.jpg)\n\n\n### [Customers](https://github.com/commercetools/commercetools-instore-center/blob/documentation/docs/customers.md)\n\n![customers](https://user-images.githubusercontent.com/576460/30800479-654af6ca-a1e0-11e7-939b-8a2f231b4847.jpg)\n\nList of customers related to the store. Provides quick access to common store customers. The user can also access to the customer details page where can see the customer insights, for instance latests items the customer purchased and some recommendations based on the latest orders or preferences.\n\nThe following image shows how the customer details page looks like:\n\n![customerinsights](https://user-images.githubusercontent.com/576460/30802006-732505e2-a1e5-11e7-9a48-225ecb221a45.jpg)\n\n![customerrecomended](https://user-images.githubusercontent.com/576460/30802271-3534a57a-a1e6-11e7-9485-e59344845957.jpg)\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcommercetools%2Fcommercetools-instore-center","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcommercetools%2Fcommercetools-instore-center","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcommercetools%2Fcommercetools-instore-center/lists"}