OneCX App Generator

The OneCX App Generator is a powerful tool that simplifies the development of UI applications within the OneCX framework. It automates the creation of key UI components, ensuring consistency and adherence to best practices.

Prerequisites

Make sure your development environment is set up correctly before using the OneCX App Generator.
The following tools must be installed and versions verified:

  • npm version should be >= 10.2.4

  • node version should be 20.11.0

  • nx - Local: v19.6.4

  • nx - Global: v20.0.6

Check versions
node --version
npm --version
nx --version
Install the Nx CLI globally
npm install -g nx@latest

In case of issues during Nx installation, try the following steps:

Nx CLI installation issue resolution
rm -rf node_modules
npm cache verify
npm install -g @nrwl/cli
npm install

Get the Generator

  1. Clone the onecx-nx-plugins repository into a folder on the local machine/inside WSL2

    git clone https://github.com/onecx/onecx-nx-plugins.git

  2. Navigate into the cloned repository and install the dependencies

    cd onecx-nx-plugins
npm install

  3. Build the OneCX App Generator

    npm run build

Generable UI Components

The following application types and components can be generated: