Getting Started

Frontend kOS projects that have been set up using the provided CLI will come pre-configured for use with the kOS UI and Dispense SDKs.

To get a development environment set up for using the SDK please follow the directions on the kOS Developer Portal.

kOS UI SDK

The kOS UI SDK includes:

1. The core Model Framework including base modules, utilities and decorators used to create new kOS Models for use in an application.
2. Common models, created using the model framework, to support cross cutting and common capabilities used in most kOS applications. These include support for Regions, Troubles, Futures as well as Configuration and State Beans.
3. React hooks and HOC to enable use of the common models in a React application.
4. Common tools and utilities.

Installation

npm install @kosdev-code/kos-ui-sdk
Copy

kos Dispense SDK

The kOS Dispense SDK enables support for consumer and admin frontend kOS applications that will make use of the dispense functions provided by the corresponding Java dispense SDK.

Consumer UI

1. Nozzles
2. Availability
3. Beverage Select and Pour

Non-Consumer

1. Assembly
2. Holders
3. Pumps
4. Ingredients
5. Ingredient Assignment

Installation

npm install @kosdev-code/kos-dispense-sdk
Copy