https://github.com/ucl/rc-cpp-vscode-dev-container
Docker container definitions for VSCode C++ development environment
https://github.com/ucl/rc-cpp-vscode-dev-container
Last synced: 10 months ago
JSON representation
Docker container definitions for VSCode C++ development environment
- Host: GitHub
- URL: https://github.com/ucl/rc-cpp-vscode-dev-container
- Owner: UCL
- License: mit
- Created: 2021-01-13T12:49:04.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-02-20T17:17:15.000Z (over 3 years ago)
- Last Synced: 2025-04-15T12:46:45.249Z (about 1 year ago)
- Language: Dockerfile
- Size: 24.4 KB
- Stars: 7
- Watchers: 4
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rc-cpp-vscode-dev-container
Docker container definitions for Visual Studio Code C++ development environment
The Dockerfile inside `.devcontainer` defines an Ubuntu docker image that can be built and linked to as a remote container from within VS code and GitHub codespaces (as well as any other editor that supports the open dev container standard). This means you can use VS Code on your host Mac, Windows, other Linux machine and be able to develop in a self contained environment matching what we recommend for PHAS0100: Ubuntu 22.04, g++ 11 and with other tools like cmake, git, clang-format already installed.
### Visual Studio Code with C++ development environment
To get setup follow the steps here https://code.visualstudio.com/docs/remote/containers-tutorial to:
* Install VS Code on your host machine (Mac, Windows, Linux variant), or use GitHub codespaces
* Install Docker Desktop on your host machine and make sure it is running
* Open VS Code and add the `Remote - Containers` extension `ms-vscode-remote.remote-containers`
* Click on the green remote containers status button at the bottom left of the window
* Then to check everything works select the `Remote-Containers: Try a Sample...` and the C++ example
* Go through the README.md and suggested things to try to familiarise yourself
To use this dev container, you can
- download the `.devcontainer` folder and include it in the root directory of your project
- Or configure this repository as a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) of your main git repository
Once you have the `.devcontainer` folder in the root directory of your project, you can then open the folder inside VS Code and it should ask if you want to reopen and build the project in the container. To test that it's working, try opening a VS Code terminal and running the command `cat /etc/os-release` and you should see the OS version is Ubuntu 22.04.
### Using docker without VS Code
If you just want to try out running from the command line, you can build and run the docker image without using VS Code. Follow the steps above to install Docker Desktop and make sure the app is running. Then clone this repository and from the command line on your host machine run the following to build and then run the docker image. From the folder containing the Dockerfile:
* `docker build -t phas0100env .`
* `docker run -it phas0100env /bin/bash`
You'll then have an interactive terminal on the Ubuntu image where you can try out any shell command.