zcatalyst-cli-plugin-react

Catalyst React plugin

The official plugin for Catalyst CLI to develop and deploy React Applications with Catalyst.

Plugin Capabilities

• This plugin allows you to serve and debug the React Application with Catalyst.
• With this plugin you'll be able to build a production ready version of your React Application and deploy it to Catalyst remote console.

Prerequisites

ZCatalyst-CLI: To install ZCatalyst-CLI with npm, use this command

npm install -g zcatalyst-cli

Check this documentation to get started with React in Catalyst

Note: zcatalyst-cli of versions 1.11.0 and above supports this plugin.

Configuring Plugin

The Plugin can be installed in two ways and needed to be configured in the catalyst.json configuration file.

Note: When setting up the React App from ZCatalyst-CLI the CLI will take care of the configuration process.

Global installation

The plugin can be installed in the global NPM node_modules directory and configured as follows

Installation

npm install zcatalyst-cli-plugin-react -g

catalyst.json

{
    "client": {
        "source": "react-app",
        "plugin": "zcatalyst-cli-plugin-react"
    }
}

Local installation

The plugin can be installed in the local node_modules directory of the React App and configured as follows

Installation

# to be executed within the React App directory
npm install zcatalyst-cli-plugin-react --save-dev

catalyst.json

{
    "client": {
        "source": "react-app",
        "plugin": "react-app/node_modules/zcatalyst-cli-plugin-react"
    }
}