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, and all of the project files will be saved in it.

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 payslip generator application, we will initialize the Advanced I/O function first, followed by the Client component.

Note: We recommend that you enter the function's package name or class name and the client's name exactly as instructed, because the application's code contains the same name.
  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:

catalyst init
  1. Navigate using the arrow keys and select your preferred portal and press the Enter key. If you have no other organizations associated with the account, then the default one will be automatically selected. catalyst_payslip_portal_choice
    You can find out more about Catalyst’s multi-org portal feature from this help document.

  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 PayslipGenerator from the list and press Enter. catalyst_payslip_project_choice

  3. Navigate using arrow keys and select Functions, Client using the space bar. Press the Enter key to initialize. catalyst_payslip_func_client_init

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

  5. Select the latest runtime of Node.js as the function stack. catalyst_payslip_func_node16_select

  6. Enter “payslip_generator_function” as the package name, “index.js” as the entry point, and your email address, as the author and press Enter. You can alternatively press Enter without entering inputs to fill in the default values. The CLI will prompt the initialization of the Node dependencies. Press Y to confirm the installation, and press Enter to confirm your choice. The Node modules will be installed. catalyst_payslip_func_init_done

  7. The CLI will now initiate the client setup. Select “Basic web app” and press Enter to initialize your client as a basic web app. catalyst_payslip_client_basic_select

  8. Enter “PayslipGenerator” as the name of your client package and press Enter. You can also provide any name of your choice. catalyst_payslip_client_basic_init_complete

Catalyst initialization is now complete.

The project directory is now set up with the client directory and the functions directory along with configuration files and dependencies. The project directory also contains the catalyst.json configuration file and a hidden .catalystrc file.

The structure of your project directory should appear as shown below: catalyst_payslip_proj_directory

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