For those comfortable with the JavaScript ecosystem, installing the tools required for Unified UX development will be a familiar process.

  • Visual Studio Code

    Visual Studio(VS) Code is a free source-code editor made by Microsoft for Windows, Linux and macOS. Features include support for debugging, syntax highlighting, intelligent code completion, snippets, code refactoring, and embedded Git. Install latest version of VS code.

    Link: VisualStudio

  • Node-LTS and NPM

    Node.js is an open-source, cross-platform, back-end, JavaScript runtime environment that executes JavaScript code outside a web browser.

    NPM is a package manager for the JavaScript programming language. It is the default package manager for the JavaScript runtime environment Node.js.

    Although UUX uses Yarn as its package manager, NPM is used to install other required libraries.

    The Node-LTS exe from below site would install both NodeJS as well as the NPM.

    Link: NodeJs

    Run the below command from cmd line to cross-check if its installed and to check the installed version.

    node --version
    (and)
    npm --version
  • Git

    Git is a distributed version-control system for tracking changes in any set of files. You can use either git bash to run Git commands or use terminal from VS code. If you choose to use the later then please make sure that the PATH in your environment variables points to git.exe, if not please add it otherwise you will not be able to run git commands from VS code terminal.

    Link: Git

    Run the below command from cmd line to cross-check if its installed and to check the installed version

    git --version
  • Yarn

    Yarn is a package manager for your code. It allows you to use and share code with other developers. Code is shared through something called a package. A package contains all the code being shared as well as a package.json file (called a manifest) which describes the package.

    Run the below command from cmd line to install Yarn

    npm install -g yarn

    Run the below command from cmd line to cross-check if its installed and to check the installed version

    yarn --version

    Link: Yarn Guide

  • Plugin

    Install Jira and Bitbucket extension for VS code for the ease of creating PRs from VS code or accessing Jira items. Follow the below link to download the extension.

    Link: Jira and Bitbucket Plugin for VS code

The Unified UX CLI is a command-line utility for creating, managing, and building Unified UX projects.

To install the utility, use NPM:

npm install --global @unified-ux/cli

Or Yarn:

yarn global add @unified-ux/cli

For either command, enable the global option. This option ensures the command is available across your operating system, rather than restricted to a specific directory.

To verify that the installation was successful, open the command line application on your computer and run the uux command. The command should return the list of option it accepts:

CLI for developing, documenting and wrapping Unified UX components
VERSION
@unified-ux/cli/1.0.0 win32-x64 node-v12.18.4
USAGE
$ uux [COMMAND]
COMMANDS
doc Generates web component documentation via mustache templates
generate Generates and/or modifies files based on a schematic.
help display help for uux
maestro Generate Unified UX components in a Maestro Component library
sass Render sass into a template, used for importable style modules in components