template-devcontainer

A template repository with a minimal VS Code devcontainer setup.

Read the full documentation online: https://compilerla.github.io/template-devcontainer

Why?

Read more in our blog post: How to support a platform-agnostic engineering team with VS Code Dev Containers.

Features

Base Docker image python:3.11 includes support for common dev tooling like git, curl, pip, and pre-commit
Includes VS Code extensions like GitLens and Prettier and good default settings for the editor
The pre-commit configuration includes a number of useful pre-commit-hooks and Compiler's conventional-pre-commit hook
A separate docs service builds documentation using mkdocs-material

Usage

Create a new repository

Create a new repository from this template.

Run the devcontainer

With the Remote - Containers extension enabled, open the folder containing this repository inside VS Code.

You should receive a prompt in the VS Code window; click Reopen in Container to run the development environment inside the devcontainer.

If you do not receive a prompt, or when you feel like starting from a fresh environment:

Ctrl/Cmd+Shift+P to bring up the command palette in VS Code
Type Remote-Containers to filter the commands
Select Rebuild and Reopen in Container to completely rebuild the devcontainer
Select Reopen in Container to reopen the most recent devcontainer build

License