Reorganize

[adrian-brady]

Codebase Reorganization

Aims to reorganize significant portions of the codebase to establish a clearer distinction between internal implementation components and public-facing, reusable components.

The primary structural change involves the addition of the internal directory for all non-public code, while the pkg directory is reserved for components designed for external use or reuse.

Changes

internal Directory

The internal directory now serves as the primary location for all code that is not to be imported or used directly by external projects or consumers - realistically none of this codebase is designed with external use in mind but still

• internal/application/ (formerly services):
  • Purpose: Intended for services that orchestrate and manage core business logic and application-specific workflows, acting as an intermediary between the domain layer and infrastructure/ui layers.
  • Benefit: Centralize application-level operations, making the flow of control easier to understand and manage.
• internal/domain
  • Purpose: Hold core business entities, objects, and abstractions.
  • Benefit/Goal: Provides a clear and isolated representation of business structures, independent of application or infrastructure
• internal/infra/ (Infrastructure)
  • Purpose: Consolidation of all infrastructure related code. This includes implementations for interacting with external systems, databases, cloud services, etc.
  • Benefit: Isolate external dependencies
  • Subdirectories:
    • internal/infra/aws/: Implementations for AWS clients, services, and data models.
    • internal/infra/database/: Houses all database-related components. This is practically just a directory move from the previous implementation.
    • internal/infra/http/: Includes HTTP request handlers, API routes, middleware, and other components related to the HTTP interface.

pkg Directory

The pkg directory is now, in theory, more purposely used, holding public-facing, reusable libraries and components.

[sarthyparty]

did you mean internal/infra?