How winderton/xplatform works
Project type and purpose
• This “xplatform” repository is a polyglot, monolithic “monorepo” composed of several mini-projects (modules), each illustrating a core CS concept or technology (Serialization, Networking, Blockchain, Event System, Full-stack Web App, etc.). It’s not a single end-to-end application but a collection of independent C++ (and a bit of Java/HTML) executables and libraries, each with its own build rules (CMake or Visual Studio projects).
File structure
• Top-level folders each represent a module/app:
• serialization – custom C++ serialization library + tests
• Blockchain – C++ core (Merkle, Ledger, Transaction, Miner), JSON helper, HTTP server/client, GUI resources, static web UI
• client – standalone C++ client CLI
• server – standalone C++ server CLI
• ide – minimal C++ IDE front-end
• renderer – OpenGL renderer + cross-platform Event System (glfw + Win32)
• userland – toy userland executable
• java – single Java Client.java
• .github – CI workflow (cmake.yml)
• vendor & .gitmodules – submodules / third-party libs
• Build scripts: CMakeLists.txt in serialization, Visual Studio project files in most modules, a solution file youtube.sln at root.
Key architectural insights from README
• Each module is self-contained and intended for demo/video tutorial.
• There’s a clear separation: libraries (serialization, core algorithms, event system) vs. applications (blockchain node, CLI client/server, IDE, renderer, web app).
• Future modules will plug into similar patterns (compilers, ECS, allocators, etc.).
Main components
– Core Libraries:
• Serialization Lib (serialization/include, src, tests)
• JSON Helper (Blockchain/src/json.h, json.hh)
• HTTP Net Lib (Blockchain/src/net: server_http, client_http, utilities)
• Event System Lib (renderer/src/Event System)
– Applications:
• Blockchain Node (core + net + GUI + web)
• CLI Client (client)
• CLI Server (server)
• Minimal IDE (ide)
• Renderer App (renderer with shaders)
• Userland Demo (userland)
• Java Client (java)
– Third-Party/Vendor: any submodules under vendor, and build tools (CMake, premake, spdlog, googletest)
– CI/CD: .github/workflows/cmake.yml
b. Relationships & interactions
– Tests (serialization/tests) depend on Serialization Lib.
– Vendor → Core Libs & Apps (show consumption of external libraries).
c. Architectural patterns & principles
– Modular Monorepo (each module with its own project file)
– Dependency Injection at compile-time (apps link to libs via CMake/VS)
– Layered design inside Blockchain Node: Core (consensus, Merkle, ledger) ← Network ← GUI ← Static Web UI
– Event-driven architecture in Renderer (Event System → Render Loop)
d. Technologies & frameworks
– C++17 (VS projects + CMake)
– Custom libs: serialization, merkleTree
– JSON header-only
– HTTP server/client (lightweight, header-only)
– GLFW + Win32 for Event System
– OpenGL shaders (.vert, .frag) in renderer
– Java (single class)
– Build/test: CMake, Google Test, spdlog, premake