Development | npmjs

MediaCentral | CloudUx-starter-kit

Installation

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

extension
Zoom
  • In your command shell type npm install -g cloudux-starter-kit. This command will install cloudux-starter-kit.
newproject
Zoom
  • Go to directory where you want to create your project and open command shell there.
  • In command shell type cloudux-starter-kit and proceed with instruction.
  • MediaCentral server host IP - is your CloudUX address that will be used for proxy development.
project_config
Zoom
  • Navigate to your project folder and open ./{your_project_name}/src/ project.config.json file.
  • For proxy development you need to set your "hostIp" with IP of your CloudUX and "proxyPort" to 443.
  • Notice: you don't need to deploy your feature pack to be able to see it in proxy mode
  • Notice: "hostIp" - is CloudUX address. It must be running to be able to use proxy development mode
npm_install
Zoom
  • In command shell type npm install and wait for modules to install.
npm_start
Zoom
  • Type npm start to run development proxy.
topBar
Zoom

Building feature-pack

NOTE: For building you need to have docker and helm installed and available in $PATH on your machine.

id_secret
Zoom
  • Once development is done set AppID aka "alias", AppSecret aka "secret" in ./{your_project_name}/src/ project.config.json file.
organization
Zoom
  • Set "organization" in ./{your_project_name}/src/package.json file.
build_done
Zoom
  • To build your project, from the root of your project type npm run buildFeaturePack to start building.
  • When building process is done you will see featurepack_name.zip file ready for deployment.

Building Docker image

NOTE: For building you need to have docker and helm installed and available in $PATH on your machine.

id_secret
Zoom
  • Once development is done set AppID aka "alias", AppSecret aka "secret" in ./{your_project_name}/src/ project.config.json file.
organization
Zoom
  • Set "organization" in ./{your_project_name}/src/package.json file.
docker_img
Zoom
  • To build Docker image, from the root of your project type npm run buildImage.
  • When building of docker image finishes, type docker images to check the built image.