Getting Started

Welcome to the OnRabbleClient developer guide. This page walks you through the steps required to build, run, and explore the core functionality of the chat client application.

Prerequisites

Before building the project, make sure you have the following installed:

• Qt 6.9.0 (or compatible)
• CMake (minimum 3.16)
• A C++ compiler supporting C++20 (e.g., MSVC 2022 or GCC 11+)
• [Optional] A WebSocket server and Keycloak instance for full integration

Cloning the Repository

git clone https://github.com/daftpy/OnRabbleClient.git
cd onrabbleclient

Building the Project

You can build the project with CMake like so:

cmake -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build

Alternatively, you may open the project directly in Qt Creator and configure the appropriate build kit.

Running the Application

Once built, run the application binary found in:

./build/bin/OnRabbleClient

Ensure that your backend WebSocket server and authentication provider (e.g., Keycloak) are running and accessible for full functionality.

Using the Application

When launched, the application will:

• Prompt you to discover a chat server via a URL
• Initiate the authentication flow
• Connect to the server and load your channels/messages

You may extend the application by adding new payload types, UI components, or message routing logic as described in the rest of this documentation.