How jimgreco/core works
Project Type and Purpose
• This is not a traditional “full-stack” web application but rather a modular, high-performance trading system (F9 proprietary trading system).
• The system is divided into four main modules:
• buildSrc: Contains code generators and Gradle build scripts for binary encoders/decoders and FIX message support.
• infrastructure: Provides low-level, allocation-free utilities for asynchronous I/O, buffer processing, collections, logging, metrics, and other core utilities.
• platform: Implements the Sequencer architecture including core services like the command shell, bus communication (both in-process and over the network), FIX protocol handling, and various application-level functionalities.
• clob: A demo/trading core implementation that shows how to build a domain-specific trading application on top of the platform.
• The README also emphasizes a command shell architecture that processes commands from files or interactive sessions (Telnet, HTTP REST, WebSocket) which is the central operational paradigm.
File Structure to Identify Modules and Architectural Layers
• Top-level directories clearly correspond to the modules (buildSrc, infrastructure, platform, clob).
• Within each module, notice a logical separation:
• In buildSrc: There is separation between groovy and java code along with resource templates (for encoder/decoder templates).
• In infrastructure: There’s a detailed organization into packages like buffer, collections, command, encoding, I/O, logging, messages, metrics, and time utilities. This indicates a layered design where each area is handled by a dedicated component.
• In platform: The code is organized around core system functions such as activation, applications (printer, sequencer, refdata), bus (including several bus implementations like inproc and mold), FIX messaging, I/O (JSON/REST/WebSocket), and shell command processing.
• In clob: It provides a concrete usage example that ties domain-specific logic (trading operations) to the platform facilities.
• Notice supporting artifacts such as checkstyle, PMD configurations, Gradle scripts, and command files (e.g., clob.cmd, vm*.cmd) which support deployment and build processes.
Final Recommendations
• Aim for clarity—separate the system into as many distinct components as possible while ensuring their interconnections are easy to follow.
• Every component and dependency is clearly labeled.
Happy diagramming!