spauly / minimum-grpc-imgui-clientservertemplate Goto Github PK

Most targets will be built into the build/ directory in the project root, disregarding the chosen build directory for CMake (e.g. release_build/). While it's only inconsistent and surprising with a single build configuration, this makes different builds (e.g. Release, Debug, Profiling, ...) in different directories impossible, as they would have to be recompiled on a build switch (or rather I would have thought so, but apparently this isn't the case. However the targets must be recompiled since the compilation flags between Debug and Release build are actually different (e.g. grpc), as far as I can see).

As a fix, the BINARY_DIRs of the external projects should be set relative to CMAKE_BINARY_DIR.

The namespace currently used (e.g. Your_Project) does not serve a real purpose yet. Instead, it could be used to better encapsulate the different parts:

• client and server
• essential parts like the GUI
• protoc elements
• utilities
• ...

The SETUP script successfully retrieves the c_cpp_properties.json but the parsing to a text format does not work.

There have been some issues trying to use external gRPC sources since the file structure (e.g. all the dependency directories) is different from the created one when building gRPC with all the dependencies from source.
Also, there is a difference with statically and dynamically linked libraries. -> this needs some further research.

Currently, the config file has to be manually changed after using the template and the name has to be changed in SUP_ROOT_FOLDER.
Instead, this should work automatically by using a variable.

• proper comments
• licensing
• description
• readme
• (documentation -> Doxygen?)

Simplify the code base for faster integration in other projects.

Currently, the build times are unnecessarily long due to everything being built. Adjust the build system here for a more efficient workflow.

Support the Bazel build system.

The include for the gRPC headers does not work correctly. Currently, these headers are supposed to be included via target_include_directories() which includes ${SUP_GRPC_BINARIES_DIR}\grpc\include and ${SUP_GRPC_BINARIES_DIR}\protobuf\include. Still using #include <grpc\grpc.h> give the error cannot open file... and not matching information provided by the ConfigurationProvider.
The same error exists for the include of ${SUP_ROOT_FOLDER}\utils.

Note that the ${SUP_...} variables are set in costum-config.cmake and can be relative paths. Still converting the grpc path e.f. to an absolute path does not solve the problem.

More information will be provided later...

When compiling with MinGW GCC I get the errors:

• expected identifier before string constant
• expected ',' or '...' before string constant

multiple times for using this string constructor: std::string m_server_address("localhost:50000"); simply using = resolves the problem.

In a private repo, I made changes to this template's core. This include:

• consistent naming of grpc variables with mgrpc
• using the member variable mgrpc_server in server init instead of temp variable _server
• more consistent namespaces
• Shutdown method for server

Create a better development workflow with clear guidelines for commit messages, pull requests and issues.
Also, implement CI/CD eventually.
See https://github.com/envoyproxy/envoy for example

Seeing the many problems a build system like this brings on different machines simply using Docker seems increasingly convenient.

Currently, the ImGUI client still is built with a console.

Unless the directory to libzlib.dll is added to PATH I get the error 'the code cannot proceed because libzlib.dll was not found'

• Quick fix is add the lib manually to path
• tried implementing this automatically but since I am building with MinGW and Unix Makefiles the macro WIN32 is never set
• adding the path to RPATH does not fix the problem for me

Add a development console that demonstrates the basics of gRPC and ImGui and is useful in debugging applications.
Features:

• send and receive test data structures
• see network activity
• log incoming and outgoing messages

The usage of hardcoded directory names like server and client is inconvenient. Change this so that it adjusts to the project name like $SUP_PROJECT_NAMEServer

Right a script that automatically fetches changes from this template and implements them into the new repository.
See here for good information: https://stackoverflow.com/questions/56577184/github-pull-changes-from-a-template-repository