Steps to Initialize, Debug, Serve, and Deploy an AppSail Service

This section presents an overview of steps for initializing, debugging, serving, and deploying an AppSail service using the Catalyst CLI, as well as an IDE to code and debug the app.

Note: You can find detailed help for the sections covered in the CLI in our CLI help documentation. The necessary help links for each action is provided in the steps below. This section primarily covers examples of debugging an AppSail service using an IDE in detail.
  1. Initializing an AppSail Service: Catalyst AppSail services can be initialized from the Catalyst CLI similar to Serverless functions and the web client component. You can initialize an app service in two ways:
  • During project initialization: Choose this method if you are initializing the AppSail service during the project’s initialization in the CLI

  • By adding it in an existing project: Choose this method if you require an AppSail service to be added to a project that has already been initialized in your local environment.

  • Standalone deploy: Choose this method if you prefer to deploy an AppSail service right away without initializing it in prior. This method combines initialization and deployment. This is suitable for apps that have already been built and tested, and are ready to be deployed to Catalyst directly.

Catalyst will obtain inputs for certain configuration information required to deploy and run your app in all cases.

Note: You can initialize an AppSail service with a pre-built sample app using the CLI. You can also pull sample apps from this GitHub repository in your terminal to get started. You will need to initialize or add an app service from the CLI and include these sample apps in the directory before deploy, or do a standalone deploy.
  1. Building an AppSail Service: After you initialize an AppSail service in the first two methods, open the Catalyst directory that your AppSail was initialized or added in your IDE. Choose an IDE based on the programming environment or runtime you are working with. The directory will be named the same name you provide for your app in the previous step. You can proceed to code your AppSail service, or migrate your existing code in this directory.

  2. Debugging an AppSail Service: You can debug your AppSail service in your IDE and test your setup. Examples of debugging apps built on specific frameworks with popular IDEs are covered in detail in the next section.

Note: Catalyst currently does not support the functionality of attaching a debugger to an AppSail app's endpoints and testing it through a local server.
  1. Serving an AppSail Service: After you complete testing your app, it will be built based on the specifications you provided and the compiled code will be available in your app’s build path. You can serve your AppSail service through a localhost from the Catalyst CLI environment before you deploy it.

  2. Deploying an AppSail Service: You can deploy your AppSail service from your local environment using the standard catalyst deploy command. This is the regular deployment option. If you had chosen to perform a standalone deployment in the first step, your app would be initialized and deployed simultaneously.

After your AppSail service is deployed to your project from your local environment, you will be able to access it in the Catalyst console, and manage, monitor, or modify its configurations as needed.

Last Updated 2024-01-04 12:37:42 +0530 +0530