npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

lr-cx-helper

v2.2.4

Published

## Overview

Downloads

14

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

tayemmahmoud87tayemmahmoud87

Keywords

Readme

Liferay Client Extension Helper

Overview

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.

Features

  • 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.

Installation

You can install lr-cx-helper globally via npm using the following command:

npm install -g lr-cx-helper

Usage - NodeJS Helper

Create NodeJS Client Extension Project

To 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>

Building Source Code and Generating CX Project

To build the source code from source code project, run the following npm command inside -source-etc-node:

npm run build

To build the source code from CX project, run the following npm command inside -etc-node:

npm run build-from-source

Compiling

To generate a single executable file for the project, please execute the following command from within the CX project directory "-etc-node".

Compiling CX Project into a Single Executable File (Windows)

To compile the CX project into a single executable file for Windows, use the following npm command:

npm run package-win

Compiling CX Project into a Single Executable File (macOS)

To compile the CX project into a single executable file for macOS, use the following npm command:

npm run package-mac

Compiling CX Project into a Single Executable File (Linux)

To compile the CX project into a single executable file for Linux, use the following npm command:

npm run package-linux

Usage - React Custom Element Helper

To 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>'

Usage - Angular Custom Element Helper

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>'

Usage - Batch Client Extension Helper

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>'