Skip to main content

Setup Development Environment

We use Visual Studio Code with the Remote - Containers extension. This lets you use a Docker container as a full-featured development environment. A devcontainer.json file in Core tells VS Code how to access (or create) a development container with a well-defined tool and runtime stack.

To get started try the following:

  1. Install Visual Studio Code
  2. Install Docker Desktop
  3. Start Docker Desktop
    • PC users: Windows limits resources to WSL 2 (Memory/CPU), this limit can be configured in your .wslconfig file.
  4. Start VS Code and add Remote - Containers Extension
  5. run Remote-Containers: Clone Repository in Container Volume... from the Command Palette (F1).
  6. Pick GitHub (You'll need to authenticate with GitHub), then enter JesusFilm/core, finally choose the main branch to clone.
  7. The VS Code window (instance) will reload, clone the source code, and start building the dev container. A progress notification provides status updates.
  8. After the build completes, VS Code will automatically connect to the container. You can now work with the repository source code in this independent environment as you would if you had cloned the code locally.