Begin Here

KOS SDK Prerequisites

Prerequisites and Requirements

To use the KOS SDK the following are going to be needed:

  • Node v18+ with either an npm or yarn package manager

  • Typescript 4.7+

  • KOS Studio

  • KOS Nexus credentials

Configuring the Package Manager (yarn or npm)

To get access to the KOS SDK in your project, configure package manager settings to use the KOS Node registry for @coca-cola scoped modules.

All of the KOS modules are currently being published to a Coca-Cola managed Node Repository https://nexus.ccfs-cm.com/repository/npm-group/. Depending on your package manager of choice you can configure it as follows:

yarn v1 (classic)

If using classic yarn (v1.x) as your package manager either update the project or global .yarnrc.

"@coca-cola:registry" "https://nexus.ccfs-cm.com/repository/npm-group/"

Alternatively, you can use the yarn CLI to add a new registry to the config:

yarn config set @coca-cola:registry https://nexus.ccfs-cm.com/repository/npm-group/

Add credentials to the yarn configuration to enable access to the coca-cola scoped modules:

yarn login --registry https://nexus.ccfs-cm.com/repository/npm-group/

yarn v2.x+

If using newer versions of yarn (v2.x+) as your package manager either update the project or global .yarnrc.yml

npmScopes:
  "coca-cola":
    npmRegistryServer: "https://nexus.ccfs-cm.com/repository/npm-group/"

Alternatively, you can use the yarn CLI to add a new registry to the config:

yarn config set npmScopes["coca-cola"].npmRegistryServer "https://nexus.ccfs-cm.com/repository/npm-group/"

Add credentials to the yarn configuration to enable access to the coca-cola scoped modules:

yarn login --registry https://nexus.ccfs-cm.com/repository/npm-group/

NPM

If using npm as your package manager either update the project or global .npmrc.

@coca-cola:registry=https://nexus.ccfs-cm.com/repository/npm-group/

Alternatively, you can use the yarn CLI to add a new registry to the config:

npm config set @coca-cola:registry https://nexus.ccfs-cm.com/repository/npm-group/

You can associate a scope with a registry at login to include your credentials:

npm login --registry=https://nexus.ccfs-cm.com/repository/npm-group/ --scope=@coca-cola
Previous
Next
On this page
Java Development
Seamlessly transition from Legacy+ systems to Freestyle microdosing and advanced distributed dispense systems.
UI Development
Using KOS SDKs, integrating Consumer and Non-consumer facing UIs becomes seamless, giving you less hassle and more time to create.
Video Library
Meet some of our development team, as they lead you through the tools, features, and tips and tricks of various KOS tools.
Resources
Familiarize yourself with KOS terminology, our reference materials, and explore additional resources that complement your KOS journey.
Copyright © 2024 TCCC. All rights reserved.