VS Code DevContainer

This repository includes configuration for a DevContainer, allowing for repeatable and reliable usage in VS Code or using GitHub Codespaces.

This document describes it’s use within a VS Code. For other options, see here.

Download and install Docker

Docker is required for running the DevContainer, please follow the Docker installation guidance for your platform.

Download and install VS Code

Visual Studio Code is Microsoft’s free IDE, it can be downloaded here: Visual Studio code.

Install required VS Code extensions

The “Remote - Containers” extension is required to use a DevContainer, it is not installed by default. Please follow the installation instructions for installing this extension.

Clone the respository and open in a DevContainer

Once the repository has been cloned, VS code will prompt to open the repository in a container, if this would not happen, it can be triggered by the command palete (CMD+Shift+p) and selecting the command ‘Reopen in container’. The first time, vs code automatically will build and run the container locally, attaching the IDE UI to it.

Once container has been opened, please go to the deployment page of the docs.

Open a Terminal within DevContainer

To open a Terminal within the DevContainer, press Ctrl+Shift+P (Cmd+Shift+P on OSX), and begin to type “Terminal”. Choose the “Terminal: Create New Terminal” option and press return.

Calls to Action

Learn more about VS Code DevContainers and get the most up-to-date information at the Visuals Studio Code Docs.

Read about using Github codespaces in the next section.