Nodeschool Public Materials

    cloudux-starter-kit

    2.2.1 • Public • Published

    pipeline status coverage report

    MediaCentral CloudUX Apps Starter Kit

    Starter kit for creating applications projects in MediaCentral

    Installation:

    Using npm just type in your CLI:

    npm install -g cloudux-starter-kit

    Using:

    CLI:

    In your CLI type:

    • cloudux-starter-kit for direct setup menu.
    • cloudux-starter-kit --help Do display help page. Installation can be executed by providing flags to your toolkit. Type --help to see details.

    Usage :

    • -C new Core project
      • -n project name (required)
      • -s project path (required)
      • -d project description (required)
      • -i MediaCentral server host IP (required)
      • -p MediaCentral port (optional)
    • -R new React project
      • -n project name (required)
      • -s project path (required)
      • -d project description (required)
      • -i MediaCentral server host IP (required)
      • -p MediaCentral port (optional)
    • -B Build project
      • -p project path (required)
      • -n project name (Should match project/src/project.json under identity.appName) (required)
      • -z app version should match project/src/project.config.json version field (required)
      • -o organization should match project/src/project.config.json organization field (required)
      • -i appID should match project/src/project.config.json appID field (required)
      • -j appSecret should match project/src/project.config.json appID field (required)
      • -d developerID should match project/src/project.config.json developerID field (optional)
      • -x https_proxy For docker build (optional)
    • -P Publish project
      • -p path to a project root (required)
      • -n project name (Should match project/src/project.json under identity.appName) (required)
      • -z app version should match project/src/project.config.json version field (required)
      • -o organization should match project/src/project.config.json organization field (required)
      • -k privateKeyPath should match project/src/project.config.json privateKeyPath field (required)
      • -i appID should match project/src/project.config.json appID field (required)
      • -j appSecret should match project/src/project.config.json appID field (required)
      • -d developerID should match project/src/project.config.json developerID field (optional)
      • -s password to ssh private key (optional)
      • -x https_proxy For docker build (optional)
    • -S Sign files
      • -k private key path (required)
      • -p private key password (optional)
      • -m path to manifest (optional)
      • -f path to files directory (optional)
      • -i developer id (assigned by Avid) (optional)
    • -I Build DockerImage
      • -p project path (required)
      • -n project name (Should match project/src/project.json under identity.appName) (required)
      • -z app version should match project/src/project.config.json version field (required)
      • -o organization should match project/src/project.config.json organization field (required)
      • -i appID should match project/src/project.config.json appID field (required)
      • -j appSecret should match project/src/project.config.json appID field (required)
      • -d developerID should match project/src/project.config.json developerID field (optional)
      • -x https_proxy For docker build (optional)

    API

    const kit = require('cloudux-starter-kit')
    kit(options)
    kit({options})
    • core -- set core to true to create new core project
      • projectName -- project name (required)
      • projectPath -- path to save project (required)
      • projectDescription -- project description (required)
      • projectHostIp -- MediaCentral server Ip (required)
      • projectPort -- port to MediaCentral server (optional)
    • react -- set react to true to create new react project
      • projectName -- project name (required)
      • projectPath -- path to save project (required)
      • projectDescription -- project description (required)
      • projectHostIp -- MediaCentral server Ip (required)
      • projectPort -- port to MediaCentral server (optional)
    • build -- set build to true to build your project
      • project -- path to your project (required)
      • name -- path to your project (required)
      • https_proxy -- For docker build (optional)
      • config -- path to your project (required)
        • version -- App version (required)
        • appID - your Application ID (required)
        • appSecret - your Application Secret (required)
        • organization -- Organization name (required)
        • developerId -- Organization name (optional)
    • publish -- set publish to true to publish your project:
      • project -- path to a project config file (required)
      • config -- path to a project config file (optional if the config is project/src/project.config.json) (required)
      • https_proxy -- For docker build (optional)
        • version -- version of your app (required)
        • organization -- name of you organization (required)
        • privateKeyPath -- Path to your private key (required)
        • appID - your Application ID (required)
        • appSecret - your Application Secret (required)
        • developerId -- your developer ID (optional) (optional)
      • name -- project name (optional if the name is in a project/src/project.json file under identity.appName) (required)
      • password -- password to ssh private key (optional)
    • sign -- set sign to true* to sign your files
      • key -- private key path (required)
      • password -- private key password (optional)
      • manifest -- path to manifest file (optional)
      • file -- path to files directory (optional)
      • id -- developer ID (assigned by Avid) (optional)
    • buildImage -- set buildImage to true to build image of your project
      • project -- path to your project (required)
      • name -- path to your project (required)
      • https_proxy -- For docker build (optional)
      • config -- path to your project (required)
        • version -- App version (required)
        • appID - your Application ID (required)
        • appSecret - your Application Secret (required)
        • organization -- Organization name (required)
        • developerId -- Organization name (optional)

    Check our CloudUX examples on Avid-Technology Github

    Check our Quick Start for CloudUX

    Install

    npm i cloudux-starter-kit

    DownloadsWeekly Downloads

    1,191

    Version

    2.2.1

    License

    SEE LICENSE IN EULA.md

    Unpacked Size

    163 kB

    Total Files

    86

    Last publish

    Collaborators

    • wbauer
    • joeapearson
    • enterit
    • anna.kryzhko
    • anna.vaskovska
    • yvadim
    • diana_chaikovska
    • vladyslav.kurakov
    • michal.oleszczuk.avid