Before installing the Open UX tools, ensure that Node.js LTS version 8 or above is installed on your system. You can download it from the official website.
For UNIX based systems, make sure you are logged in as a user with sudo privileges.
You can view how to install Node on Linux and other operating systems via a package manager here.
Once Node is installed, you'll have access to the
npm command, which you can use to install Open UX packages from the NPM repository.
Yarn is an alternative to NPM that downloads packages from the same repository but offers a range of benefits over NPM. Throughout this documentation, examples are provided with both NPM and Yarn.
Installing the CLI
To install the utility, use NPM:
npm install --global @transact-open-ux/cli
yarn global add @transact-open-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
transact command. The command should return the list of option it accepts:
Usage: <command> [options] Options: -V, --version output the version number -h, --help output usage information Commands: create [options] [directory-name] create a new transact-open-ux application deploy [options] deploys app to Transact Manager mock [options] provides Open UX API mocking via running an express server Run transact <command> --help for detailed usage of given command.
Installing a Library
The Open UX CLI provides the tooling for managing projects, but to develop with it you'll need to install at least one library that contains the API calls for interacting with Transact Manager.
Right now, there are two libraries available:
The Core Library contains the essential elements for working with the Transact Manager API. If you create a project with the
transact create command, this library will be installed automatically. To install it manually, read the Open UX Core Library page.
The React Library is a higher-level library for React developers. It contains components that abstract away many of the lower-level details. If you create a project with the React template, this library will be installed automatically. To install it manually, read the Open UX React Library page.