-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
763 additions
and
252 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,83 +1,67 @@ | ||
| # Logistics Wizard ERP | ||
| # Acme Freight ERP Quick Links | ||
| - [Go to the Acme Freight journey website](http://developer.ibm.com/code/journey/unlock-enterprise-data-using-apis?cm_mmc=github-code-_-native-_-acme-_-journey&cm_mmca1=000019RT&cm_mmca2=10004796) | ||
| - [View the main Acme Freight repository](https://github.com/ibm/acme-freight) | ||
| - [Skip to the Acme Freight ERP LoopBack tutorial](https://github.com/ibm/acme-freight/APIC-ERP-README.md) | ||
| - [Read the blog post about implementing LoopBack for Acme Freight's ERP system](https://developer.ibm.com/code/2017/05/04/unlock-enterprise-data-with-loopback?cm_mmc=github-code-_-native-_-acme-_-related-content&cm_mmca1=000019RT&cm_mmca2=10004796) | ||
|
|
||
| | **master** | [](https://travis-ci.org/strongloop/acme-freight-erp) [](https://coveralls.io/github/strongloop/acme-freight-erp?branch=master) | | ||
| | ----- | ----- | | ||
| | **dev** | [](https://travis-ci.org/strongloop/acme-freight-erp) [](https://coveralls.io/github/strongloop/acme-freight-erp?branch=dev)| | ||
|
|
||
| This service is part of the larger [Logistics Wizard](https://github.com/strongloop/acme-freight) project. | ||
| # The Acme Freight Journey | ||
|
|
||
| ## Overview | ||
| Acme Freight Shipping is a fictional shipping and logistics company using the [Logistics Wizard](https://github.com/ibm-bluemix/logistics-wizard) application framework to reimagine supply chain optimization systems for the 21st century. | ||
|
|
||
| With the Logistics Wizard app, we focus on the planning and delivery of products from distribution centers to retail locations. The Logistics Wizard ERP service defines a subset of a full ERP system data model and the API to access this system. | ||
| Acme Freight uses an application, called [Logistic Wizard](https://github.com/ibm-bluemix/logistics-wizard) to manage some of its assets. The application is composed of several microservices, including three Cloud Foundry applications and multiple OpenWhisk actions. | ||
|
|
||
| ### API Definition | ||
| Acme Freight uses LoopBack, an open source Node.js framework, built for quickly creating and exposing APIs for new and existing applications and data. LoopBack enables Acme Freight to create an application that integrates with their existing ERP system, and API Connect allows them to expose data via a managed API. | ||
|
|
||
| The API and data models are defined in [this Swagger 2.0 file](spec.yaml). You can view this file in the [Swagger Editor](http://editor.swagger.io/#/?import=https://raw.githubusercontent.com/strongloop/acme-freight-erp/master/spec.yaml | ||
| ). | ||
| *For more on the Acme Freight journey and the technologies behind it, [visit the Acme Freight journey website](http://developer.ibm.com/code/journey/unlock-enterprise-data-using-apis?cm_mmc=github-code-_-native-_-acme-_-journey&cm_mmca1=000019RT&cm_mmca2=10004796).* | ||
|
|
||
| The API allows to: | ||
| * log in and get access tokens; | ||
| * get the list of Products, Distribution Centers, Retailers; | ||
| * create, retrieve, update, delete Shipments. | ||
|
|
||
| The API defines the following roles: | ||
| * supply chain manager - can view all data and manage Shipments | ||
| * retail store manager - can view all data except Inventory and Suppliers | ||
| ## Acme Freight Tutorials | ||
|
|
||
| ### Logistics Wizard ERP Simulator | ||
| To start learning more about Acme Freight and the technology behind it, jump to one of the tutorials below. | ||
|
|
||
| This project includes an ERP simulator implementing the API and data models defined above. With the simulator we remove the dependency on a real ERP giving us more flexibility to demonstrate edge cases like connectivity failures. | ||
| ### Deploy Acme Freight | ||
| * [Deploy your own Acme Freight with IBM DevOps Toolchain](https://github.com/ibm/acme-freight/blob/master/TOOLCHAIN-README.md) | ||
|
|
||
| ## Supported use cases | ||
| ### Rapidly Create APIs with the Node API Framework, LoopBack | ||
| * [Use LoopBack and API Connect to rapidly expose ERP data with APIs](https://github.com/ibm/acme-freight/blob/master/APIC-ERP-README.md) | ||
|
|
||
| The ERP service can be used to demonstrate different capabilities and configuration of IBM Bluemix. | ||
| ### Create APIs for OpenWhisk actions in just a few clicks | ||
| * [Create an API for your OpenWhisk actions on Bluemix](https://github.com/ibm/acme-freight/blob/master/OW-NAPI-README.md) | ||
|
|
||
| ### Basic configuration to support for the use cases of the other services | ||
|
|
||
| In this configuration, the ERP service is only providing access to the data. | ||
| We deploy the ERP simulator as a regular Cloud Foundry app in Bluemix and connect it to the rest of the system. | ||
| ## Acme Freight Architecture | ||
|  | ||
|
|
||
| This configuration illustrates: | ||
| * how to document an API with Swagger.io | ||
| * how to quickly implement an API with Loopback.io | ||
| * how to configure auto-scaling to cope with additional load | ||
| * how to manage failures of a backend service and how to recover when it becomes available again | ||
| * lost of connectivity between the ERP service and its database | ||
| * lost of connectivity between the other services and the ERP service | ||
| The following projects are leveraged in the overall Acme Freight solution: | ||
|
|
||
| [**>>> Follow these instructions to deploy and work with this configuration.**](README-BASIC.md) | ||
| * [acme-freight-erp](https://github.com/ibm/acme-freight-erp) - defines the API used by Acme Freight to access data from an ERP system. It also provides a default implementation to be used as a simulator. The simulator is a Node.js application connected to a PostgreSQL database. Through its API, it manages users (supply chain managers and retail store managers), distribution centers, retail stores and shipments. | ||
|
|
||
| ### Hybrid configuration to access a on-prem ERP service | ||
| * [acme-freight-webui](https://github.com/ibm/acme-freight-webui) - provides a dashboard to view ongoing shipments and alerts. There is no log-in or user credentials per se to use the deployed applications. Instead a unique demo ID is assigned to any new user trying the application. Behind each demo ID, Acme Freight creates an isolated environment with a default set of business users, distribution centers, retail stores, shipments. Refer to the [walkthrough](WALKTHROUGH.md) to get a tour of the capabilities. | ||
|
|
||
| In this configuration, the Secure Gateway sits between the ERP service and the other services. All calls to the ERP service go through the Secure Gateway. We don't require a real on-prem ERP system, the ERP simulator is used. | ||
| * [acme-freight-recommendation](https://github.com/ibm/acme-freight-recommendation) - makes shipment recommendations based on weather conditions. It is a set of Bluemix OpenWhisk to retrieve current weather conditions and given a weather event to generate new shipment recommendations. These recommendations could then be turned into real orders. | ||
|
|
||
| This configuration illustrates: | ||
| * how to expose an on-prem service outside of the enterprise | ||
| * how to configure the security settings of the Secure Gateway | ||
| * [acme-freight-controller](https://github.com/ibm/acme-freight-controller) - acts as the main controller for interaction between the services. It receives requests from the user interface and routes them to the ERP or the weather recommendation module. | ||
|
|
||
| [**>>> Follow these instructions to deploy and work with the hybrid configuration.**](README-HYBRID.md) | ||
| *Acme Freight is forked and extended from the IBM Bluemix project, Logistics Wizard. Visit the Logistics Wizard project [wiki](https://github.com/IBM-Bluemix/logistics-wizard/wiki) for a detailed breakdown of the original Logicistics Wizard architecture and deployment strategy.* | ||
|
|
||
| ## License | ||
|
|
||
| See [License.txt](License.txt) for license information. | ||
| ## Overview | ||
|
|
||
| # Privacy Notice | ||
| With the Acme Freight app, we focus on the planning and delivery of products from distribution centers to retail locations. Acme Freight's ERP service defines a subset of a full ERP system data model. | ||
|
|
||
| This application is configured to track deployments to [IBM Bluemix](http://www.ibm.com/cloud-computing/bluemix/) and other Cloud Foundry platforms. The following information is sent to a [Deployment Tracker](https://github.com/IBM-Bluemix/cf-deployment-tracker-service) service on each deployment: | ||
| Acme Freight uses LoopBack to expose existing ERP data via an API and API Connect to secure and manage the API.  | ||
|
|
||
| * Node.js package version | ||
| * Node.js repository URL | ||
| * Application Name (`application_name`) | ||
| * Space ID (`space_id`) | ||
| * Application Version (`application_version`) | ||
| * Application URIs (`application_uris`) | ||
| * Labels of bound services | ||
| * Number of instances for each bound service and associated plan information | ||
|
|
||
| This data is collected from the `package.json` file in the application and the `VCAP_APPLICATION` and `VCAP_SERVICES` environment variables in IBM Bluemix and other Cloud Foundry platforms. This data is used by IBM to track metrics around deployments of sample applications to IBM Bluemix to measure the usefulness of our examples, so that we can continuously improve the content we offer to you. Only deployments of sample applications that include code to ping the Deployment Tracker service will be tracked. | ||
| ### API Definition | ||
|
|
||
| ## Disabling Deployment Tracking | ||
| The API and data models are defined in [this Swagger 2.0 file](spec.yaml). You can view this file in the [Swagger Editor](http://editor.swagger.io/#/?import=https://raw.githubusercontent.com/ibm/acme-freight-erp/master/spec.yaml | ||
| ). | ||
|
|
||
| Deployment tracking can be disabled by removing `require("../tracker");` from the beginning of the `server/server.js` file. | ||
| The API allows to: | ||
| * log in and get access tokens; | ||
| * get the list of Products, Distribution Centers, Retailers; | ||
| * create, retrieve, update, delete Shipments. | ||
|
|
||
| [bluemix_signup_url]: https://console.ng.bluemix.net/?cm_mmc=GitHubReadMe | ||
| The API defines the following roles: | ||
| * supply chain manager - can view all data and manage Shipments | ||
| * retail store manager - can view all data except Inventory and Suppliers |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| product: '1.0.0' | ||
|
|
||
| info: | ||
| name: logistics-wizard-erp | ||
| title: logistics-wizard-erp | ||
| version: '1.0.0' | ||
|
|
||
| apis: | ||
| 'logistics-wizard-erp': | ||
| $ref: logistics-wizard-erp.yaml | ||
|
|
||
| visibility: | ||
| view: | ||
| type: public | ||
| subscribe: | ||
| type: authenticated | ||
|
|
||
| plans: | ||
| default: | ||
| title: Default Plan | ||
| description: Default Plan | ||
| approval: false | ||
| rate-limit: | ||
| value: 100/hour | ||
| hard-limit: false |
Oops, something went wrong.