HackerChat

HackerChat is messaging platform the nostalgic computer geek. It is a simple chat client that allows user to chat with other users all within the terminal.

Table of Contents

• Dependencies
• Installation
• Usage
• Features
• Contributing
• License

Dependencies

• Requires Linux or Unix like operating systems
  • Will port to Windows in the future
• C++17 Compiler
• Boost (Min. Version 1.83.0) ASIO and Beast Libraries
  • ASIO and Beast libraries and installation instructions can be found here
• Rapid Json (Min. Version 1.0)
• PugiXml (Min. Version 1.14)
• CMake (Min. Version 3.26)

  Installation

• Clone the repo

  $ git clone https://github.com/landoshepherd/HackerChat.git

  HackerChatServer

• Navigate to HackerChatServer directory

  $ cd HackerChat/HackerChatServer

• Run CMake to create Makefile

  $ cmake -B build/ ./

• Navigate to build directory and run make command to build HackerChatServer executable

  $ cd HackerChat/HackerChatServer/build
  $ make

  HackerChatClient

  • Navigate to HackerChatClient directory

    $ cd HackerChat/HackerChatClient

• Run CMake to create Makefile
• Note: External includes and libraries should be at this location. This is where CMake will find all of the files necessary to build the makefile.
• The "build" directory is where the cmake build artifacts, including the makefile and eventually the executable, will be located.

  $ cmake -DEXTERNAL_FILES_DIR=/path/to/external/files -B build/ ./

  • Define HACKERCHAT_CLIENT_CONFIG_DIR environment variable
  • To run the HackerChatClient successfully, it needs to know where the HCClientConfig.json file is located. This is where the websocket and all other configurations will be stored.

    $ export HACKERCHAT_CLIENT_CONFIG_DIR=/path/to/config/dir

• Navigate to build directory and run make command to build HackerChatClient executable

  $ cd HackerChat/HackerChatClient/build
  $ make

  Usage

  • Open two separate terminals
  • In one terminal navigate to HackerChatServer executable and run program

    $ cd HackerChat/HackerChatServer/build
    $ ./HackerChatServer

  • In the other terminal navigate to HackerChatClient executable and run program

    $ cd HackerChat/HackerChatClient/build
    $ ./HackerChatClient

  • In the HackerChatClient terminal, type in a message and press enter.
  • 

• The same message should appear in the HackerChatServer terminal and echoed back to the HackerChatClient terminal.
• 
• 

Features

• TBD

  Contributing

• TBD

  License

• MIT License