Development

This page explains how to install the Deltasimulator in the development mode and how to setup development environment with Docker and VSCode. We recommend developing from inside the development container. When using any Makefile targets from within that container, please use the dev- prefix. An example of this can be seen in Run tests.

Prerequisites

For operating systems, we primarly support Ubuntu 20.04.
We use a Docker container for our development envionment, so follow the instructions here. Please ensure to follow the steps to configure permissions correctly for your user account.
While it is possible to use any IDE, we support the use of VSCode. If so we recommend you install the ms-azuretools.vscode-docker and ms-vscode-remote.vscode-remote-extensionpack extensions.

Install

Clone this repository

$ git clone https://github.com/riverlane/deltasimulator.git
$ cd deltasimulator

Build the Docker image (this might take a while)
```
$ make build
```

Set up VSCode’s development container:

$ cp .devcontainer/devcontainer_template.json .devcontainer/devcontainer.json

To open the project in the container click on the Dev Container button at the bottom left of VSCode and choose Remote-Containers: Open Folder in Container.

Run tests

There are two ways to run tests locally:

Execute them in a container by running
```
$ make test
```
Or from the development container
```
$ make dev-test
```

Build docs

There are two ways to build docs locally:

Execute them in a container by running
```
$ make docs html
```
Or from the development container
```
$ make dev-docs html
```