Development Environment

This page describes the setup of a recommended development environment. To simplify the setup, the development environment will run inside a Docker container. We use Microsofts free Visual Studio Code editor and its Development Container feature for managing and connecting to this container.

VILLASnode comes with a pre-configured devcontainer.json file.

note

The page roughly follows the tutorial from Microsoft on this topic: Remote development in containers.

Alternatively, we provide just a Docker image containing all development dependency which can be used alone without Visual Studio Code at via:

docker run --privileged ghcr.io/villasframework/node

Requirements

• Git
• Docker Desktop
• Microsoft Visual Studio Code
  • Including Remote - Containers extension

Setup

1. Install Docker Desktop and Microsoft Visual Studio Code
2. Start Docker
3. Start Visual Studio
4. Install the the Remote - Containers extension.
5. Clone the VILLASnode source code or open an existing folder containing it:
   • Ctrl+Shift+P → Git: clone → https://github.com/VILLASframework/node.git
   • When asked Would you like to open the cloned repository? click on Open
   • When asked Select a kit for node press Esc
6. Re-open in development container:
   • Ctrl+Shift+P → Remote-Containers: Reopen in Container
7. Build VILLASnode
   • Ctrl+Shift+P → CMake: Build

Both Microsoft's CMake and C++ Tools extensions are installed automatically and allow you to build and debug the C++ source code via Visual Studios Code's standard procedure.