Launch Quick Start Guide with Remix

The fastest way to get started with Remix on Launch is by creating a project by importing the website code from GitHub or Bitbucket Cloud.

This document guides you through the process of creating a project using GitHub.

Prerequisites

• Contentstack account
• Launch-enabled Organization with Owner or Admin permissions
• GitHub account

What You Will Learn

• How to import a GitHub repository into Launch.

• How to configure build and output settings for a Remix project.

• How to add environment variables to a Launch project.

• How to deploy the project and preview the live site.

Steps for Execution

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

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

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

4. Click GitHub.

   

   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 new page opens. Sign in or create a new GitHub account.

5. Enter your credentials and log in.

   

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.

   

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.

   

   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 this guide, we have selected the Remix portfolio repository from our Launch example namespace.

      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.
   5. Build and Output Settings (Mandatory): The fields in this section get auto-populated based on the Remix framework, as discussed above. Ensure that the Output Directory is set to ./build

      Select a response mode:

      • Streaming: Delivers response chunks in real time as they are generated.
      • Buffered: Displays output only after the entire response has been generated.

      Note: Buffered is selected by default.

      

      Note: The Server Command field allows you to deploy Remix as Server-Side Rendered.

   6. Environment Variables (Optional):
      • Enter the key and value of one or more environment variables.
      • You can also add the key-value pairs in bulk in the Bulk Edit section.
      ENVIRONMENT=Production
      SAMPLE_KEY=SAMPLE_VALUE

      

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

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

   At first, the screen shows the Deploying status while the project deployment is in progress.

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:

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

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