How martijn-vd-h/solid-workshop works
CSharp OrderModule
2. Reveal JS presentation (a slide deck likely for a SOLID workshop or technical presentation)
Typescript OrderModule
──────────────────────────────
Project Types and Their Purposes
• CSharp OrderModule:
– Purpose: This project implements an order processing module in C#.
– It includes a “Core” library (OrderModule.Core) that contains business logic such as order processing, validation, email notification, API calls, and price calculations.
– It makes use of interfaces (e.g., IAPICaller, IEmailService, ILogger, IOrderValidator, IPriceCalculator) with concrete implementations found within a “Services” folder.
– A separate test project (“OrderModule.Core.Tests”) exists for unit testing the core functionalities.
• Typescript OrderModule:
– Purpose: Similar to the C# version, this project appears to provide core order module logic implemented in TypeScript.
– The structure includes a “src” folder with a “core” directory containing the OrderModule logic and a “tests” folder with corresponding test definitions.
• Reveal JS Presentation:
– Purpose: It is a full presentation slide deck built with RevealJS.
– It includes all resources required for the slide deck (HTML, CSS, JavaScript, plugins, examples, and even a dedicated section on SOLID principles).
– Although it is not directly part of the business module, it serves as a demonstration or support material for the workshop or speaker session.
──────────────────────────────
File Structure to Derive Main Components
For the CSharp OrderModule:
• Components to highlight:
• OrderModule.Core:
▪ Domain/Business Logic (OrderModule.cs, Program.cs, etc.)
▪ Interfaces (defining contracts for services like API calls, sending emails, validation, logging, and price calculation).
▪ Services (actual implementations such as APICaller, EmailService, ConsoleLogger, OrderValidator, PriceCalculator).
• OrderModule.Core.Tests:
▪ Unit tests targeting the core component interactions (OrderModuleTests.cs).
For the Typescript OrderModule:
• Components to include:
• src/core/OrderModule.ts representing the core business functionality.
• src/tests (OrderModule.test.ts) representing the test suite for the order module’s functionality.
For the Reveal JS Presentation:
• Components to include:
• HTML/CSS/JS structure: “index.html”, CSS theme directories, JavaScript controllers and utilities.
• Plugin modules (e.g., markdown, math, notes, search, and zoom).
• Resource directories (assets and examples) that support the presentation.
• This part of the repository is designed to visually present content. Illustrate its dependency structure (core RevealJS engine, plugins, configuration files).
──────────────────────────────
A. Main Components and Their Relationships:
• One section for the CSharp OrderModule.
• One section for the Typescript OrderModule.
• A third section for the Reveal JS Presentation.
• Within each section, highlight subdivisions:
• CSharp:
▪ “OrderModule.Core” as the primary business logic layer.
– List subcomponents: Interfaces and Services (each with labels like IAPICaller with its implementation APICaller, IEmailService with EmailService, etc.).
▪ “OrderModule.Core.Tests” which interacts with the Core logic.
• Typescript:
▪ “src/core/OrderModule.ts” as the core module.
▪ “src/tests” outlining test cases that validate the functionality of the core module.
• Reveal JS Presentation:
▪ “index.html” as the entry point.
▪ CSS (theming, layout, print) and JavaScript folders.
▪ Plugin system and additional assets.
B. Highlighting Architectural Patterns and Design Principles:
• For the OrderModule (both C# and TypeScript):
• Use of interface-based design (allowing for decoupled implementations).
• Separation of concerns: business logic is kept separate from presentation/testing.
• Unit test modules as critical for verifying domain logic.
• For the Reveal JS presentation:
• Modular design via plugins.
• Separation between core framework, themes, and custom slide content.
C. Relationships and Data Flow:
• For the presentation, if applicable, illustrate how the main RevealJS engine loads plugins and configuration files.
──────────────────────────────
• A clear partitioning of the repository’s three aspects (CSharp core module, Typescript variant, and the RevealJS presentation).
• The key components within each area along with their interactions.
• Notable design patterns such as dependency injection (implied by the interface and services separation) and modular design (especially in the presentation layer).
• Nodes that represent the build/test pipelines (e.g., the “OrderModule.Core.Tests” and the “src/tests” folders) as fundamental to ensuring stability.