Getting Started with Catalyst

This quick start guide covers setting up your Zoho Catalyst development environment and creating your first project, whether you are building a web app, a microservice or a mobile backend.

Before you begin

Make sure your system has the following installed:

• Node.js and NPM: needed to install and use the Catalyst CLI, and to build Node.js functions.
• Java SE Development Kit (JDK): needed for Java-based functions.
• Python: needed if you are working with Python functions.
• An IDE of your choice, such as VS Code, IntelliJ or PyCharm.

Step 1: Create a 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 Catalyst’s services and start configuring your project.

Step 2: Install the Catalyst CLI

Open your terminal and run:

npm install -g zcatalyst-cli

Check it installed correctly with catalyst --version. If you hit permission issues, try running the install command with sudo.

Step 3: Log in from the CLI

In your terminal, run catalyst login, choose whether to allow Catalyst to collect error reports, and sign in with your Zoho credentials when the browser window opens. Click Accept to grant access, then close the browser and return to the CLI.

Step 4: Initialise your project locally

1. Create a folder on your local system and open your terminal there.
2. Run catalyst init.
3. Choose the components to set up, such as Serverless functions or a CloudScale client, and select the Catalyst project you created in step 1.
4. If initialising a function, provide the details Catalyst asks for: for Java, the reference name and main class; for Node.js, the package details; for Python, the package and entry file names. For a client, just provide a name for the client package.

Your 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

Open your IDE and start coding your client or functions based on the components you initialised, using the SDK guides for Java, Node.js, Python, Web, Android, iOS or Flutter, or the API documentation.

Step 6: Test locally

Before deploying, test your app or microservice locally by running catalyst serve in your project directory. This gives you local URLs to access and test your app, client and functions, and you can also use the CLI’s Node shell to run and test functions.

Step 7: Deploy your project

Once everything looks good, deploy with catalyst deploy. Your app is then live in the Development environment. To move to Production, set up Catalyst Payments and deploy again from the CLI or the console. You can also host web apps through the console, upload function bundles directly, and manage and distribute mobile apps through Mobile Device Management.

Tips

• Keep the CLI updated to get the latest features and fixes.
• Use version control, such as Git, to manage your Catalyst project code.
• Start simple, then add components as your app grows.
• Check the logs in the console or CLI to debug issues quickly.
• Use the Catalyst sandbox environment to test integrations before going live.