Initialize the Project from the CLI

We have now configured all the necessary components from the console. Next, we’ll be working on coding the application from our local system

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 the portal (or organization) that you created your project in by navigating using the arrow keys and press Enter to confirm.

    select-org

  2. Now, CLI will 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.

    select-proj

  3. Select Functions and Client using the space bar. Press the Enter key to initialize.

    select-comp

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

    function-setup

  5. Select Python 3.9 as the function stack, and press Enter.

    select-python

  6. Press Enter to confirm the default package name as lead_manager_function and the entry point as main.py.

    functions-setup2

The CLI will download and install the latest Catalyst Python SDK package.

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. Choose Basic web app.

    basic-webapp

  2. Provide the name of the client as “LeadManagerApp”.

    done-client-setup

Note: 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 functions and client directory is now 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, a requirements.txt file and a hidden catalyst.rc file.

directory

Note: The above image includes an additional file login.html. This is the final directory structure of your project. We will create login.html while configuring the client directory.

Last Updated 2023-12-15 18:54:08 +0530 +0530