Skip to content

Latest commit

 

History

History
85 lines (54 loc) · 4.89 KB

developing_in_a_GitHub_Codespaces.md

File metadata and controls

85 lines (54 loc) · 4.89 KB
Raw

Developing in a GitHub Codespaces

Getting started with GitHub Codespaces

A codespace is a development environment that's hosted in the cloud. You can customize your project for GitHub Codespaces by committing configuration files to your repository, which creates a repeatable codespace configuration for all users of your project.

Creating your GitHub Codespaces

  1. Click on Open in GitHub Codespaces

  2. New window will open where you can create a new codespace

  3. First you will need to select your repository you forked from the Information Assistant repo

  4. Next, by default you will be on main branch, you can switch to specific branch where you would like to create a Codespaces.

  5. Then select options for Region and Machine type. The "Dev Container configuration" will be pre-populated and does not need to be changed.

  6. Next, click on Create codespace GitHub Codespaces creation

  7. Then it automatically start building container in the github codespaces ( wait for until container successfully created) Building container

  8. When you create a new codespace from a template, it is always opened in the Visual Studio Code web client. You can reopen an existing codespace in any supported editor Codespaces in vscode

Using GitHub Codespaces in Visual Studio Code

GitHub Codespaces provides you with the full development experience of Visual Studio Code. You can develop in your codespace directly in Visual Studio Code by connecting the GitHub Codespaces extension with your account on GitHub.

You can use your local install of Visual Studio Code to create, manage, work in, and delete GitHub Codespaces. To use GitHub Codespaces in VS Code, you need to install the Codespaces extension. For more information on setting up GitHub Codespaces in VS Code, see "Prerequisites."

Prerequisites

To develop in a codespace directly in VS Code, you must install and sign into the GitHub Codespaces extension with your GitHub credentials. The GitHub Codespaces extension requires VS Code October 2020 Release 1.51 or later.

Use the Visual Studio Code Marketplace to install the GitHub Codespaces extension. For more information, see Extension Marketplace in the VS Code documentation.

  1. In VS Code, in the Activity Bar, click the Remote Explorer icon. Remove Explorer Tab in VS Code

    Note: If the Remote Explorer is not displayed in the Activity Bar:

    • Access the Command Palette. For example, by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux).
    • Type: details.
    • Click GitHub Codespaces: Details.

  2. Select "GitHub Codespaces" from the dropdown at the top of the "Remote Explorer" side bar, if it is not already selected.

  3. Click Sign in to GitHub.

    Sign into GitHub button in VS Code

  4. If you are not currently signed in to GitHub you'll be prompted to do so. Go ahead and sign in.

  5. When you're prompted to specify what you want to authorize, click the Authorize button for "GitHub."

  6. If the authorization page is displayed, click Authorize Visual-Studio-Code.

Opening a codespace in VS Code

  1. In VS Code, in the Activity Bar, click the Remote Explorer icon.

    Remote Explorer Icon in VS Code

  2. Under "GitHub Codespaces", hover over the codespace you want to develop in.

  3. Click the connection icon (a plug symbol).

    Connections Icon in VS Code

Navigating to an existing codespace

  • You can see every available codespace that you have created at github.com/codespaces.

    Available Codespaces in GitHub.com

  • Click the name of the codespace you want to develop in. Alternatively, you can see any of your GitHub Codespaces for a specific repository by navigating to that repository and selecting Code. The dropdown menu will display all active GitHub Codespaces for a repository.