Initialize the Project from the CLI

You can now begin working on your Catalyst project from the CLI. The first step is to initialize the project in an empty directory. This will be the home directory of your project, where all of your project files are saved.

You can learn more about this from the Project Directory Structure help page. You can learn about initializing a project in detail from the CLI help documentation.

For the Lead Manager application, we will initialize the Advanced I/O function in the Java or Node.js environment, and the client component.

  1. Create a folder for the project on your local machine and navigate to it from the terminal.

  2. Initialize a project by executing the following command from that directory:

copy
$
catalyst init
  1. Select Client and Functions using the space bar. Press the Enter key to initialize.
    catalyst_leadmanager_init_1

  2. The CLI will now ask you to associate a Catalyst project with the directory. Associate it with the project that we created earlier from the console. Select LeadManager from the list and press Enter.
    catalyst_leadmanager_init_2

  3. The CLI will initiate the function setup. Select AdvancedIO as the function type.
    catalyst_leadmanager_init_3

  4. Select the required runtime of Java as the function stack, and press Enter.
    catalyst_leadmanager_init_4

  5. Enter “crmCRUD” as the folder name and “CRMCRUD” as the class name. Press Enter each time.
    catalyst_leadmanager_init_5
    The CLI will download and install the latest Catalyst Java SDK package on your local system.

Note: Ensure that you enter the package name, or class name and folder name, exactly as instructed, because the application's code contains the same names.
  1. The CLI will initiate the client set up next. Enter “LeadManagerApp” as the name for the client package and press Enter.
    catalyst_leadmanager_init_7
    You can enter any name you need. However, you can use the same name that you used while enabling Zoho sign-in to maintain standardization.

    The client directory will be created in the standard structure. Catalyst initialization is now complete.

Your project directory (CATALYST_PROJECT_HOME) is now set up with the client directory (CATALYST_CLIENT_HOME) and the functions directory (CATALYST_FUNCTIONS_HOME) along with configuration files and dependencies. The project directory also contains the catalyst.json configuration file and a hidden catalyst.rc file.

This is the structure of your project directory.

catalyst_leadmanager_proj_dir_struct_java

Note: These images includes an additional file login.html. This is the final directory of your project. We will create login.html while configuring the client directory.

Last Updated 2023-12-19 12:35:38 +0530 +0530