@c8y/websdk

@c8y/websdk Package Overview

The @c8y/websdk Angular schematic enables quick scaffolding of custom Cumulocity applications. It sets up an Angular environment integrated with essential Cumulocity features, allowing developers to efficiently focus on creating unique IoT solutions within the Cumulocity platform.

How to use

Install

Install the Angular 16 @angular/cli package.

npm install @angular/cli@v16-lts -g

Generate a new Angular 16 application:

ng new <appName> --interactive=false --routing=true --style=less

Navigate to the application directory:

cd <appName>

Use the ng add command to include @c8y/websdk, and follow the prompts.

ng add @c8y/websdk

Bypass prompts:

ng add @c8y/websdk --application=@c8y/<appName>@<version> --skip-confirmation

Note: In the bypass prompts scenario:

• <appName> must be one of the following: administration, application, cockpit, codex, devicemanagement, hybrid, package-blueprint, tutorial, widget-plugin.
• <version> denotes the specific package version listed in the npm registry.

Run development server & build

Launch the development server:

ng serve -u https://<yourTenant>.latest.stage.c8y.io/

Build the application:

ng build <appName>