lr-cx-helper is a command-line tool designed to simplify the generation of Liferay Node.js backend Client extension project structures. This tool automates the creation of two projects: one to host your source code and another to host the Liferay client extension. The primary goal of lr-cx-helper is to streamline the process of compiling and building Node.js projects into a single executable file while minimizing the source code and encapsulating all required dependencies within it. This eliminates the need for manual installation of dependencies using npm i, making deployment and distribution more straightforward.
- Project Generation: Automatically generates project structures for Liferay Node.js backend Client extensions.
- Dependency Management: Minimizes the source code and encapsulates dependencies within the project, eliminating the need for manual installation.
- Compilation and Building: Facilitates the compilation and building of Node.js projects into a single executable file for simplified deployment.
- Create React Custom Element: Facilitates the creation of react custom element inside Liferay Workspace and fix index.js file to expose a standard web component.
You can install lr-cx-helper globally via npm using the following command:
npm install -g lr-cx-helperTo create a new project using the helper, please use the following command:
lr-cx-helper init-nodejs -n <project-name> -p <optional: target project directory> -t <project-title> -sp <service port>To build the source code from source code project, run the following npm command inside -source-etc-node:
npm run buildTo build the source code from CX project, run the following npm command inside -etc-node:
npm run build-from-sourceTo generate a single executable file for the project, please execute the following command from within the CX project directory "-etc-node".
To compile the CX project into a single executable file for Windows, use the following npm command:
npm run package-winTo compile the CX project into a single executable file for macOS, use the following npm command:
npm run package-macTo compile the CX project into a single executable file for Linux, use the following npm command:
npm run package-linuxTo use the helper to create a react custom element, please run the below command inside your Liferay Workspace
LiferayWorkspace / client-extensions /
lr-cx-helper init-react -n <Custom Element Project Name> -t '<Custom Element Title>' -h '<HTML Element Name>' -ic '<include Clay true / false>' -iu '<include Utils true / false>'To use the helper to create an angular custom element, please run the below command inside your Liferay Workspace
LiferayWorkspace / client-extensions /
lr-cx-helper init-angular -n <Custom Element Project Name> -t '<Custom Element Title>' -h '<HTML Element Name>'To use the helper to create a Batch CX Project, please run the below command inside your Liferay Workspace
LiferayWorkspace / client-extensions /
lr-cx-helper init-batch -n '<Project Name>' -t '<Project Title>'