Skip to content
This repository has been archived by the owner on Sep 28, 2022. It is now read-only.

kuzzleio/sdk-cpp

Repository files navigation

Build Status

Official Kuzzle C++ SDK

About Kuzzle

A backend software, self-hostable and ready to use to power modern apps.

You can access the Kuzzle repository on Github

SDK Documentation

The complete SDK documentation is available here

Protocol used

The C++ SDK implements the websocket protocol.

Build

Execute the following snippet to clone the GIT repository, and build the SDK. It will then be available in the "build/" directory

git clone --recursive git@github.com:kuzzleio/sdk-cpp.git
cd sdk-cpp
git submodule update --init --recursive
make

Installation

You can find prebuilt SDK's for each version and architecture on our download page.

Tests

To manually run the bundled tests on this SDK, you need the following dependencies installed:

  • boost libraries (https://www.boost.org/)
  • cucumber, cmake & valgrind: sudo apt install -y cmake cucumber valgrind

Once done, you can start the functional tests with the following command:

./run-tests.sh

The test results are printed to the standard output.

Functional tests are monitored by valgrind. The report is available here: ./test/_build_cpp_tests/valgrind_report.log