Skip to content

Create devcontainer.md #10631

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Create devcontainer.md #10631

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions devcontainer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Setting Up and Using a Development Container

## Prerequisites
- Visual Studio Code (VSCode) installed
- Remote - Containers extension for VSCode

## Steps to Create and Use a DevContainer

1. **Install Visual Studio Code**: Download and install VSCode from the official website.

2. **Install the Remote - Containers extension**: In VSCode, navigate to the Extensions view and search for "Remote - Containers". Install the extension developed by Microsoft.

3. **Create a DevContainer Configuration**: In your project directory, create a `.devcontainer` folder. Inside this folder, create a `devcontainer.json` file. This file will contain the configuration for your development container.

4. **Define the Dockerfile**: Within the `devcontainer.json` file, specify the Dockerfile for your development environment. Define the base image, dependencies, and any additional configurations required for your project.

5. **Configure the Development Environment**: Customize the `devcontainer.json` file to include any specific setup steps or configurations needed for your project.

6. **Build the DevContainer**: Use the Remote - Containers extension in VSCode to build the DevContainer. This extension provides options to build, rebuild, or modify your development environment.

7. **Connect to the DevContainer**: After building the container, use the Remote - Containers extension to connect to it. This will open a new VSCode window connected to your DevContainer, providing an isolated development environment.

8. **Work within the DevContainer**: Start coding and developing within the DevContainer. Ensure any changes made are isolated within the container for consistent development across environments.

9. **Save and Commit Changes**: Upon completion, save your changes and commit them to your version control system to ensure proper tracking of changes made within the DevContainer.

These are general instructions, and the specifics may vary depending on the technology stack and project requirements. Adjust the steps accordingly to fit your needs.