Development | npmjs

MediaCentral | CloudUx-starter-kit

Installation

NOTE: Before you proceed you need to have nodejs and npm installed.

  1. Open Toolkit page. There is a lot of useful information there In your terminal / cmd type npm install -g cloudux-starter-kit

  2. Go to directory where you want to create your project and open terminal / cmd there ActiveApp

  3. In terminal / cmd type cloudux-starter-kit and proceed with instruction ActiveApp

  1. In terminal / cmd type npm install and wait for modules to install after that type npm start ActiveApp
  1. In browser go to https://localhost:8080. You should be able to see your app ActiveApp

Publishing

NOTE: For publishing you need to have docker version 17.05 or higher and helm installed an available in $PATH on your machine.

  1. Once development is done you need AppID and AppSecret to publish your app to AVID sellers portal you can find more information in our Quick Start

  2. In your {project}/src/project.config.json fill all fields below identity and signing.

  3. In your {project}/src/package.json file under avid there is field alias it should contain your appId.

    Also secret field should contain your app secret. Developer ID and organization are also mandatory.

    • If you are using cloudux-starter-kit version below 2.0.0
  4. You can publish your application using cloudux-starter-kit

    • If you are using cloudux-starter-kit version 2.0.0 or higher:
  5. If your private ssh key (from point 2) have password, please add it to {project}/scripts/publish.js in the field password. If you don't use password don't change anything

  6. From the root of your project type npm run publish to upload your application to marketplace. npmPublish

  7. After publishing is done you should be able to go to your's product's page and see installation file. installer

Building feature-pack

NOTE: For building feature-pack you need to have docker version 17.05 or higher and helm installed an available in $PATH on your machine.

  1. To build feature-pack you will need AppID and AppSecret, you can find more information in our Quick Start

  2. In your {project}/src/project.config.json fill all fields below identity and signing.

  3. In your {project}/src/package.json file under avid there is field alias it should contain your appId.

    Also secret field should contain your app secret. Developer ID and organization are also mandatory.

    • If you are using cloudux-starter-kit version below 2.0.0
  4. You can build docker image for your application using cloudux-starter-kit

    • If you are using cloudux-starter-kit version 2.0.0 or higher:
  5. From the root of your project type npm run buildFeaturePack to build it. f-p-b

  6. When building process will finish in the root of your project you will find new feature-pack.

f-p-s

Building docker image

NOTE: For building image you need to have docker version 17.05 or higher and helm installed an available in $PATH on your machine.

  1. To build docker image you will need AppID and AppSecret, you can find more information in our Quick Start

  2. In your {project}/src/project.config.json fill all fields below identity and signing.

  3. In your {project}/src/package.json file under avid there is field alias it should contain your appId.

    Also secret field should contain your app secret. Developer ID and organization are also mandatory.

    • If you are using cloudux-starter-kit version below 2.0.0
  4. You can build feature-pack for your application using cloudux-starter-kit

    • If you are using cloudux-starter-kit version 2.0.0 or higher:
  5. From the root of your project type npm run buildImage to build image.

  6. When building docker image will finish type docker images in CLI you should see image with your project.

f-p-s