Skip to content

Latest commit

 

History

History
54 lines (45 loc) · 1.93 KB

Architecture.md

File metadata and controls

54 lines (45 loc) · 1.93 KB

Project Architecture

Overview

This document provides an overview of the project's architecture, including the key components, their interactions, and the overall design philosophy. The project is divided into three main components, CLI, GitService and Shared.

Project Structure

├── src/
│   ├── CLI/
│   ├── GitService/
│   └── Shared/
└── tests/
    ├── UnitTests/
    └── IntegrationTests/

CLI

  • Purpose: Handles the command line interface, user input and branch assembly. Also the main entry point for the application.
  • Dependencies: GitService, Shared
  • Technologies: .NET Console Application

GitService

  • Purpose: Fetches and parses git information into the Shared component.
  • Dependencies: Shared
  • Technologies: .NET Class Library

Shared

  • Purpose: Contains shared classes used by both the CLI and GitService.
  • Dependencies: None
  • Technologies: .NET Class Library

Tests

  • Purpose: Contains unit and integration tests for the CLI and GitService components.
  • Dependencies: CLI, GitService, Shared
  • Technologies: .NET Core xUnit, NSubstitute

Interactions Between Components

  • The CLI invokes commands that are processed by the GitService.
  • The GitService fetches Git data and uses utilities from the Shared module to format or store the results.
  • Both CLI and GitService rely on the Shared project for reusable components like logging, configuration, and error handling.
+--------+
| Shared | <----------------+
+--------+                  |
    A                       |
    |                       |
    |                       |
+--------+           +------------+
|  CLI   |  -------> | GitService |
+--------+           +------------+