Launch Quick Start Guide with Analog

The fastest way to get started with Launch is to clone and deploy a sample Analog Starter project. With Launch, you can easily create a project by importing your website code from GitHub.

1. Contentstack account
2. Access to Launch for your organization
3. GitHub account

Follow the steps given below to deploy your first Launch project using GitHub:

Note Only the Organization Admin/Owner has the right to create projects in a stack for Launch.

1. Log in to Contentstack and click the Launch icon from the dashboard, as shown below:
   Click to enlarge
2. On the Launch Projects screen, click the + New Project button to initiate the project creation process.
   Click to enlarge
3. From the Create New Project modal, click Import from a Git Repository.
   
   Click to enlarge

   Note You can also choose to upload a .zip file to import a project.

4. Click GitHub.
   Click to enlarge

   Additional Resource You can also import a project using Bitbucket Cloud. Follow the steps in the Create a Project Using Bitbucket Cloud guide to proceed.

   A Sign in to GitHub screen pops up. Enter your credentials and log in to your GitHub account.

   Note We have assumed that you have a GitHub account and your website code stored in the repository.

5. Enter your credentials and log in.
   Click to enlarge
6. In the Repository access section, select All repositories.
   

   Note If you want to choose specific repositories, select the Only select repositories option and choose the required repository.

   Click to enlarge
7. Click the Save button.
   

   Note If you are accessing GitHub through Contentstack for the first time, you must authorize Contentstack by clicking the Install & Authorize button after selecting All repositories.

   Click to enlarge

   You will be redirected to the Launch app.

8. In the Create New Project modal, add the following details:

   1. Repository (Mandatory): Select the Git repository. In our example, we have selected the Analog Starter App repository.

      Note When you select the repo, the Build and Output Settings section gets auto-populated.

   2. Git Branch (Mandatory): By default, master or main is selected as the branch. You can choose another branch from the dropdown.
   3. Project Name (Mandatory): Gets auto-populated on selecting the repository. You can edit it as per your requirement.
   4. Environment Name (Mandatory): Enter the name of the environment.
      Click to enlarge
   5. Build and Output Settings (Mandatory): The fields in this section get auto-populated based on the Analog framework, as discussed above. Update the Output Directory to ./dist/contentstack-analog-starter-app
      Click to enlarge
      Note

      • The Server Command field allows you to deploy Analog as Server-Side Rendered. In most cases, this command will be npm preview.
      • Leaving the Server Command field blank will deploy the framework as CSR (Client-Side Rendered).
   6. Environment Variables (Optional):
      1. Enter the key and value of one or more environment variables.
      2. You can also add the key-value pairs in bulk in the Bulk Edit section.

      For the Contentstack Analog Starter to work, we need to provide the following environment variables:

      12345678

      CONTENTSTACK_LIVE_PREVIEW=<true_or_false>
      CONTENTSTACK_MANAGEMENT_TOKEN=<mgmt_token>
      CONTENTSTACK_DELIVERY_TOKEN=<delivery_token_of_the_environment>
      CONTENTSTACK_API_HOST=<api_host_value>
      CONTENTSTACK_REGION=<region>
      CONTENTSTACK_APP_HOST=<app_host_value>
      CONTENTSTACK_API_KEY=<api_key_of_your_stack>
      CONTENTSTACK_ENVIRONMENT=<environment_name>

      Click to enlarge

      Note Click Back to revert the changes and re-enter details.

9. Once ready, click Deploy to save and deploy the project.

   As soon as the deployment starts, you will see the Deploying status as shown in the following screenshot:

   Click to enlarge

Upon successful deployment, you will see the following screen. You can preview the deployed website by clicking the icon next to the URL in the Domains section:

Click to enlarge

If you want to deploy the changes from any other commits, you can click the Redeploy button and choose the required commit.

Click to enlarge

Note The log details of the current deployment can be found under the Logs section.

Click to enlarge

By default, Analog is deployed as a Single-Page Application (SPA). To deploy Analog as an SSR-based application, follow the steps below:

1. On the top navigation panel, click the Settings icon and then Environments.
   Click to enlarge
2. Click the Deployments tab to navigate to the deployment settings screen.
3. In the Server Command field, add the command present in the package.json file to run the SSR based build locally. For example:
   1

   node dist/my-app/server/server.mjs

   Note The Server Command field will be displayed in the Deployments tab only if you choose Analog as the framework.

4. Click the Save Deployment Settings button.
   Click to enlarge
5. To redeploy the environment with the latest updates, follow these steps:
   1. Click the Environments icon on the top panel and then click the environment where the updates are made.
   2. In the Deployments screen that appears, click the Redeploy button to redeploy on the environment.

Once deployed, your application will start rendering pages on the server. You can inspect and verify the application content for accuracy.