This project uses a development container to provide a consistent development environment. The container is defined using Docker and configured for Visual Studio Code.
- Docker installed on your machine
- Visual Studio Code installed on your machine
- Remote - Containers extension installed in Visual Studio Code
-
Clone the repository:
git clone <repository-url> cd <repository-directory>
-
Open the repository in Visual Studio Code:
code .
-
Reopen in Container:
- Press
F1
to open the command palette. - Type
Remote-Containers: Reopen in Container
and select it.
- Press
Visual Studio Code will build the Docker image defined in the .devcontainer
folder and start a container with the specified configuration.
-
Dockerfile: The container is built using the
Dockerfile
located in the.devcontainer
folder. It usesubuntu:20.04
as the base image and installscurl
,git
, andvim
. -
devcontainer.json: The configuration file for the development container.
- name: The name of the container.
- build: Specifies the Dockerfile to use for building the container.
- customizations: Custom settings for Visual Studio Code.
- settings: Sets the default shell to
/bin/bash
. - extensions: Installs the
ms-vscode.cpptools
andms-python.python
extensions.
- settings: Sets the default shell to
- postCreateCommand: Command to run after the container is created.
- workspaceFolder: The folder to open in the container.
- workspaceMount: Mounts the local workspace folder into the container.
After the container is created, the following command is run:
echo 'Container setup complete!'