Getting Started with Catalyst

Before You Begin: What You’ll Need

Make sure your system is ready with the following installed:

• Node.js and NPM – Required for installing and using the Catalyst CLI, and for building Node.js functions.
• Java SE Development Kit (JDK) – Needed for Java-based functions.
• Python – If you’re working with Python functions.
• An IDE of your choice – For writing and editing your code (e.g., VS Code, IntelliJ, PyCharm).

Step 1: Create a New Catalyst Project

1. Log in to the Catalyst Console.
2. Click Create a New Project.
3. Give your project a name in the popup window.
4. Click Access Project to open it.

You can now explore various Catalyst services and start configuring your project. Visit each service’s help section to learn more about what it offers.

Step 2: Install the Catalyst CLI

To work with Catalyst locally, you’ll need to install the Catalyst CLI (Command Line Interface).

1. Open your terminal and run:

npm install -g zcatalyst-cli

1. Check if it’s installed correctly:

catalyst –version

 If you run into permission issues, try using sudo before the install command.

Once installed, you’ll be able to use the catalyst command to manage your projects from the terminal.

Step 3: Log In from the CLI

• In your terminal, run:

catalyst login

1. Press Y to allow Catalyst to collect error reports (optional).
2. Log in using your Zoho credentials when the browser window opens.
3. Click Accept to grant access permissions.
4. Close the browser and return to the CLI.

Step 4: Initialize Your Project Locally

1. Create a folder on your local system and open your terminal in that directory.
2. Run: catalyst init

1. Choose the components you want to set up (like Serverless functions or CloudScale client).
2. Select the Catalyst project you created in Step 1.
3. If initializing a function:
   • For Java, enter the reference name, main class, and install the SDK.
   • For Node.js, enter package info and install dependencies.
   • For Python, enter the package and entry file names.

If you’re adding a client, just provide a name for the client package.

 The very first project must be created through the Catalyst Console. After that, you can create new projects directly from the CLI.

Step 5: Develop Your Application

Now it’s time to write your code! Open your preferred IDE and start coding your client or functions based on the components you initialized.

Here are helpful SDK guides to assist you:

• Java SDK
• Node.js SDK
• Python SDK
• Web SDK
• Android SDK
• iOS SDK
• Flutter SDK
• API Documentation

Step 6: Test Locally

Before deploying, test your app or microservice locally.

In your project directory, run:

catalyst serve

You’ll get local URLs in your terminal to access and test your app, client, and functions.

You can also use the Node shell from the CLI to run and test functions.

Step 7: Deploy Your Project

Once everything looks good, deploy your project to the Catalyst cloud:

catalyst deploy

Your app will be live in the Development environment. To move to Production, set up Catalyst Payments and deploy it again from the CLI or the console.

 You can also:

• Host web apps through the console.
• Upload function bundles directly.
• Manage and distribute mobile apps via Mobile Device Management.