Setup Docker for Development Environment

[chrisdedman]

Description:

We need to set up Docker for the development environment to standardize the development setup and ease the testing process. This will allow developers to build install and test the project inside a container with all necessary dependencies, ensuring consistency across environments.

Tasks:

• Create a Dockerfile for the development environment.
  • Include all necessary dependencies for the project (e.g., C++, Cmake, Make, etc.).
  • Include test on multi-platform build (e.g., Mac, Linux, Windows, look at GitHub workflows for example).
• Document the setup process in the wiki.
  • Provide instructions on how to build and run the Docker containers.

Important

The Docker container is not intended to serve as a platform for running the software. Instead, we intend to run it locally by executing the make command. Docker’s primary purpose is to facilitate testing cross-platform compatibility by building and installing the software on various operating systems within Docker containers (such as a simulation of GitHub Action inside Docker).

Expected Outcome:

• A fully functional Docker setup for local cross-platform testing.
• The ability to build and install the project within containers, ensuring a consistent environment across different systems.
• The ability to run unit tests within Docker
  • Unit Tests within Docker are blocked until Create Unit Tests #13 is done (or Init Unit Tests #14 is merged).