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 this application, we will initialize a Event Function, which will contain the logic of the action that is required to occur once the event happens and a Basic web app as the client component.

Note: Ensure that you enter the function's package name or class name exactly as instructed, because the application's code contains the same name.

Create a folder for the project on your local machine and navigate to it from the CLI.
Initialize a project by executing the following command from that directory:

copy
$catalyst init

Navigate using the arrow keys, 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 selected automatically.

Note: You can find out more about Catalyst’s multi-org portal feature from this help document.

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 EventApp from the list and press Enter.
Navigate using the arrow keys and select Functions, Client using the space bar. Press Enter to initialize.
The CLI will initiate the function setup. Select Event as the function type for your Event function.
Select the latest runtime of Node.js as the function stack.
Enter “event_app” as the package name, “index.js” as the entry point, and your email address as the author, then press Enter. Alternatively, you can 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.

The CLI will now initiate the client setup.

Select Basic web app and press Enter to initialize your client as a basic web app.
Enter a name for your client package and press Enter. For the purposes of this tutorial, we are naming our client package “EventAppClient”. You can use the same of provide a name of your choice.

The 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 now appear as shown below: catalyst_tutorial_event_app_proj_dir

Last Updated 2024-10-22 16:44:11 +0530 +0530

Initialize CLI Resources Project Directory Structure