Development Environment

If using VS Code, a development environment is available. The development environment includes everything needed for editing, testing and linting.

Requirements

The following requirements are needed to use the development environment:

• Visual Studio Code
• Visual Studio Code Dev Containers extension
• Docker - Only the Docker Engine package is required for Linux

Instructions

First make sure the requirements are installed.

Clone the ExaCheck repository:

SSH TransportHTTPS Transport

git clone git@github.com:exacheck/exacheck.git

git clone https://github.com/exacheck/exacheck.git

In VS Code, go to File -> Open Workspace from File. You can then browse to the repository that was cloned and select the exacheck.code-workspace file.

VS Code will then prompt you to reopen the workspace in the development container. The development container will then be pulled. The VS Code extensions will be automatically install inside the development container.

On container creation the create.sh script will be executed. This script will install all Python modules required using Poetry.