Installation

This chapter describes the minimal requirements to install and use this package.

Requirements

To use this package you have to fulfill the following requirements:

• Supported operating systems: Windows, Mac and Linux
• Node.js >= 14.17.5
• NPM >= 6.14.14
• A code editor e.g. Visual Studio Code, IntelliJ or Web Storm

Editors like Visual Studio Code, Atom or Sublime are suitable for small projects. For bigger projects we recommend using one of the JetBrains products.

To test your design you need access to an instance of BSI CX.

Installation

This section describes the steps to install the package as NPM dependency. If you are interested in contributing to this project, please consider the chapter about contributing to this project.

To install and use this package check first you fulfill the minimal requirements. In order to install the package navigate to your project's root folder (where your package.json is located and execute the following command:

npm install --save-dev github:bsi-software/bsi-cx-design-build#semver:^1.0.0

This will install the package and all its required dependencies. Your package.json should contain the following devDependencies afterwards:

"@bsi-cx/design-build": "github:bsi-software/bsi-cx-design-build#semver:^1.0.0"