cs-icon.svg

Create a Project Using GitHub

Launch lets you connect your GitHub account and access the repositories while creating projects. You must first connect your GitHub account to Launch to create projects using your GitHub repositories.

This document guides you through the process of connecting your GitHub account and creating a project in Launch using the GitHub repositories.

Prerequisites

Connect your GitHub account to Launch and deploy a project

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

  1. Click the Launch option from the left navigation panel, as shown below. 
  2. Launch_-_Navigation.png

  3. Click New Project
  4. Launch_Project_List_Page2

  5. From the Create New Project modal, click Import from a Git Repository
  6. Launch-GitHub-ImportFromGit.png

  7. Click GitHub
  8. Launch-GitHub-ConnectAccount.png

    A pop-up will open with connection details.

  9. Enter the login credentials for your GitHub account. 
  10. Launch-Sign-In.png

  11. Select the option to choose All repositories or Only select repositories, and then click the Save button. 
  12. Launch_New_Repository_Access_SS.png

    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. 

    Launch-GitHub-Install_Authorize.png

    The Create New Project modal appears with the deployment steps.

    Now you can either proceed with the deployment steps or click Cancel to view the GitHub connection you just created. 

    Launch-GitHub-ConnectedSuccessfully.png

    Note: GitHub displays a Connected tag on successful connection to Launch in the Create New Project modal.

  13. If you selected Cancel in the previous step, click GitHub to proceed with the deployment steps.
  14. Fill in the following details to deploy your project in Launch.
    1. Repository (Mandatory): All repositories from your GitHub organization are listed in the Repository dropdown.
      • Click the Select repository dropdown. 
      • Launch-GitHub-SelectRepoDropdownIcon.png

        Note: The repositories listed depend on the configuration you choose while installing the app.

      • Select the repository with which you want to create a project.
    2. Git Branch (Mandatory): Once a repository is selected, the Git Branch dropdown populates with the repository’s default branch. The Detected framework section detects and displays the supported framework based on the GitHub repository you selected.
      • Select a branch from the dropdown to select a different branch.
      • Launch-GitHub-GitBranch.png
    3. Project Name (Mandatory): The project name is auto-populated based on the repository you selected.
      • If you want to use a different project name, enter a project name without exceeding 200 characters.
    4. Environment Name (Mandatory): By default, the environment name is populated as Default. You can change the environment name as per your requirement.
    5. Launch_Create_Proj_Using_GitHub_CreateNewProj_Modal_Env_Proj.png
    6. Build and Output Settings (Mandatory): The fields in this section get populated based on the detected framework.
      • Framework Preset(Mandatory): Framework of the selected project.
      • Build Command (Mandatory): Command to build the project.
      • Output Directory (Mandatory): Directory path where the project’s build output files get stored.
    7. Environment Variables (Optional)
      • Enter the key and value of your environment variables, in the Key Value Edit section.
      • You can also add the key-value pairs in bulk in the Bulk Edit section.
      • Click the + Add Environment Variable button to add more environment variables. 
      • Launch-QuickStartNextJS-CreateNewProjModal-Env_Var-Values.png
    8. Once all the fields are filled with appropriate values, click the Deploy button. 

You have successfully deployed a project! 

Launch-GitHub-DeploymentSuccess.png

To delete the project:

  1. Click the Settings icon.
  2. In the General section, click the Delete Project button under Delete Project.
  3. Launch_Create_GitHub_Venus2_General_Settings_DeleteProject.png

  4. Enter DELETE and then click the Yes, Delete button.
  5. Launch_Create_GitHub_Venus2_General_Settings_DeleteModal.png

    This deletes your project successfully.

Was this article helpful?
^