How pakanrahmani/framework works
Main Components
• Build & Infrastructure: Include the BuildScript directory, which handles build automation (using NUKE, .csproj files, and associated build scripts), showing the integration with CI/CD pipelines.
• Core Modules: This includes the fundamental assemblies under Code/Src/Framework.Core (handling chaining of handlers, events, exceptions, logging, and utilities) along with Domain and Messaging modules under Code/Src/Framework.Domain and Code/Src/Framework.Messages.
• Application and API Integration: Under Code/Src/Framework.Application and Framework.AspNetCore, you have components that manage command bus execution, middleware, HTTP context features, and conventions tailored to web applications.
• Cross-Cutting and Infrastructure Services:
• Authorization (Framework.Authorization)
• Configuration and Dependency Injection (Framework.Config and Framework.Config.Autofac)
• Logging (e.g., Framework.Logging.SeriLog)
• Testing utilities (Framework.Testing.Core)
• Data Access Layer: This is split into several strategies:
• Entity Framework (EF)
• MongoDB
• NHibernate (NH)
Each module under Code/Src/Framework.DataAccess.* means you have a clear separation in persistence technologies.
• Messaging and Event Handling: Components for message bus, event publishing, and distributed events are evident in:
• Framework.MassTransit, Framework.RabbitMQ, Framework.Kafka, and Framework.EasyNetQ.
• Utility and Extensions: Framework.Utility and additional helpers/extensions included across modules.
• Miscellaneous Modules: Additional areas such as FileUpload, Swagger integration (Framework.Swagger), RESTful builders (Framework.Restful), and Specification patterns (Framework.Specification).
Architectural Patterns and Principles
• Separation of Concerns and Dependency Injection: Emphasize the use of dependency injection (Autofac modules, configuration loaders) to decouple different layers.
• CQRS and Event-Driven Architecture: Explicitly show command and query separation as well as event aggregation and publication that underpin many of the modules.
• Cross-cutting Services: Components like Authorization and Logging should be noted as aspects that weave into numerous other modules.
Essential Elements
• A clearly labeled build/infrastructure block at the top (or on the side) showing BuildScript and CI/CD integration.
• Modules for both the application layer (Framework.Application and Framework.AspNetCore) and the core domain logic (Framework.Core, Framework.Domain, and Framework.Specification).
• Messaging components such as RabbitMQ, Kafka, MassTransit, and EasyNetQ placed near a “Messaging/Event Handling” block.