This repository provides a Dev Container to easily set up a development environment. Using Dev Container allows you to work in a consistent development environment with pre-configured dependencies and tools, whether locally or in the cloud with GitHub Codespaces.
For Local Development:
- Docker Desktop or any other compatible container runtime (e.g., Podman, OrbStack) installed.
- Visual Studio Code with the Remote - Containers extension installed.
For GitHub Codespaces:
- A GitHub account.
Using Visual Studio Code (Local):
- Clone the repository.
- Open the repository in Visual Studio Code.
- Open the command palette in Visual Studio Code (
Ctrl + Shift + PorCmd + Shift + P) and executeDev Containers: Reopen in Container.
Using GitHub Codespaces (Cloud):
- Navigate to the repository on GitHub.
- Click the "<> Code" button.
- Select the "Codespaces" tab.
- Click "Create codespace on main" (or your desired branch).
Dev Container settings are configured in .devcontainer/devcontainer.json. In this file, you can set the Docker image to use, extensions to install, port forwarding, and more. This configuration is used both for local development and GitHub Codespaces.
Once the Dev Container is started, you can proceed with development as usual. The container already has the necessary tools and libraries installed. In GitHub Codespaces, you will have a fully configured VS Code in your browser or desktop application.
Using Visual Studio Code (Local):
To stop the Dev Container, open the command palette in Visual Studio Code and execute Remote: Close Remote Connection.
Using GitHub Codespaces (Cloud):
GitHub Codespaces will automatically stop after a period of inactivity. You can also manually stop the codespace from the Codespaces menu in GitHub.
This document describes the basic usage of Dev Container and GitHub Codespaces. Add project-specific settings and procedures as needed.