memorisecodead / chitchat

Efficient chat implementation in C++

A simple and efficient C++ implementation of a messenger using the popular boost::beast and boost::asio libraries for networking.

---

Getting started

Conan

This is an open source, decentralized and multi-platform package manager for C/C++.

Install Python:

• Windows: Python 3.12.0.exe

• Linux: $ sudo apt-get update

$ sudo apt-get install python3.12

Install Conan:

• Windows/Linux: $ pip install conan==1.61.0
• Windows/Linux: conan-source-execution files

CMake

CMake is a cross-platform, open-source build system generator.

Install CMake:

• Windows: cmake-3.27.0-win64-x64.msi

• Linux: cmake-3.27.0-Linux-x86_64.sh

chitchat's Issues

Network Refactoring

You Should Refactoring Network Base

And there is:

• Adding coments for other network parts of code
• Renaming BeastAttribute.hpp and addicted parts of it
• Prepearing Code base for Doxygen Documentation (use Doxy styleguide)

Need to fix HTML bug...

You need to use SonarCloud analyzer to fix the bug.

Terms: SonarCloud check must pass and

Introduction To Project

Familiarise yourself with basic documentation,

how to work on a project,
and understand the project structure, how everything works.

YOU WILL SHOULD TO KNOW HOW TO MAKE COMMIT

Also to be:
1. Familiarise yourself with your tasks.
2. Ask questions if it is not clear
3. Review code

Cover Network Tests

Complete tests and display coverage using Sonar.
Also pay attention to workflow

Cleaning Smells...

For our reasons,
you should clean smells in our code base with SonarCloud.

What should you do:

1. Decide smells for 0
2. Decide bugs for 0

Getting New Style Of Pr.

You have should to update project style with other style things: pages, uses architecture, uses languages(remark with pictures).

Write catch2 tests for back side of ChitChat

Cover the HTTPSession & Listener, WebSocket classes using the Catch2 library:

1. Client interaction
2. Data exchange

Set up CI/CD

Writing .yml files for each section of code.
Customising the github for testing

Documentation via Doxygen

What is required to be done:

1. Add Doxygen to the project
2. Configure it
3. Check code comments
4. Generate documentation

Cover HTML page with tests

Cover the unit test JavaScript part of the code using the Mocha or Jasmine library.

Also write E2E(End-to-end) tests: simulate real user interaction with an HTML page.
For E2E testing use frameworks like Cypress or Selenium WebDriver.

Upgrade HTML-Page

Rewrite the HTML page of ChitChat:

1. Improve the interface: add animations
2. Redesign the page
3. Arrangement of objects (buttons, fields)