Build Guide

Ready to use and develop the MQSS Client? This guide will help you get started.

Initial Setup

1. Fork the MQSS Client repository on GitHub (see Fork a Repo.
2. Clone your fork locally

git clone git@github.com:your_name_here/MQSS-Client.git

1. Change into the project directory

cd MQSS-Client

1. Create a branch for local development

git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

1. (Optional, highly recommended) Install pre-commit to automatically Run a set of checks before each commit.

Prerequisites

To build the MQSS Client, the following components are required.

1. CMake, From Version 3.19 to 3.30.
2. Compiler that supports C++-17 (Every version after Clang 5 and GCC 8).
3. Doxygen 1.15 to build documentation.
4. CURL to communicate with the REST API.
5. RabbitMQ-C to communicate with the RabbitMQ Queues.
6. Niels Lohmann's JSON to parse the JSON data.
7. Pybind11 to create Python bindings.

[!NOTE] We strongly recommend using Dev Containers with Visual Studio Code. We provided the required configurations.

Build

As stated earlier, building the project requires a C++ compiler supporting C++17 and a minimum CMake version version 3.19.

After cloning the repository and changing the directory, run the command below to configure the project:

cmake -S . -B build

After the configuration, run the command below to build the project:

cmake --build build