Adam
/
Mango.Nop.Libraries
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
92 Commits 4 Branches 0 Tags 16 MiB
C# 100%
Go to file
Loretta 5535011df9 Comprehensive documentation overhaul and expansion 
- Added detailed .md docs for Core, Data, and Services projects: DTOs, NopDependencies, repositories, transactions, services, and logging bridge
- Updated all project README.md files with metadata, documentation tables, inheritance diagrams, and clearer dependency/reference explanations
- Root README.md now includes a documentation map and improved project/type tables
- Expanded and clarified `.github/copilot-instructions.md` as the single source of truth for domain rules, patterns, and conventions
- Updated ARCHITECTURE.md, CONVENTIONS.md, and GLOSSARY.md to document DTO strategies, transaction and logging patterns, project boundaries, and AyCode integration
- Added CLAUDE.md for Claude-specific code authoring guidance
- All .csproj files now include new docs as non-compilable content
- Ensured clear separation of concerns and improved AI/tooling discoverability across the codebase
 		2026-03-30 10:26:35 +02:00
.github Comprehensive documentation overhaul and expansion 2026-03-30 10:26:35 +02:00
Mango.Nop.Core Comprehensive documentation overhaul and expansion 2026-03-30 10:26:35 +02:00
Mango.Nop.Data Comprehensive documentation overhaul and expansion 2026-03-30 10:26:35 +02:00
Mango.Nop.Services Comprehensive documentation overhaul and expansion 2026-03-30 10:26:35 +02:00
docs Comprehensive documentation overhaul and expansion 2026-03-30 10:26:35 +02:00
.gitignore merge 2024-11-11 13:50:52 +01:00
CLAUDE.md Comprehensive documentation overhaul and expansion 2026-03-30 10:26:35 +02:00
README.md Comprehensive documentation overhaul and expansion 2026-03-30 10:26:35 +02:00

README.md

Mango.Nop Libraries

For library domain rules see: .github/copilot-instructions.md For detailed docs see: docs/

Shared nopCommerce extension libraries providing domain entities, DTOs, data access, and service base classes. All target net9.0 (nopCommerce 4.80.9 requirement).

Projects

Project Purpose Key Types
Mango.Nop.Core Domain entities, DTOs, interfaces, nopCommerce entity mirrors (zero nopCommerce runtime dep) MgEntityBase, ModelDtoBase<T>, MgOrderDto<,>, MgOrderItemDto<>, MgProductDto, CustomerDto, MgGenericAttributeDto, MgStockTaking<>, GenericAttributeExtensions
Mango.Nop.Data Data access layer — repository base classes, DB context, transactions MgDbTableBase<T>, MgDtoDbTableBase<,>, MgDbContextBase, MgDalBase<T>
Mango.Nop.Services Service base classes — background services, session, events, locking, logging MgBackgroundServiceBase, MgSessionServiceBase<T>, MgEventConsumerBase, MgLockServiceBase, NopLogWriter

Dependency Graph

See docs/ARCHITECTURE.md for full dependency graph, project roles, DTO mapping strategies, and transaction patterns.

AyCode.Core (DLL references)
    ↑
Mango.Nop.Core (net9.0, zero nopCommerce runtime dependency)
    ↑
Mango.Nop.Data (net9.0) → Nop.Core, Nop.Data
    ↑
Mango.Nop.Services (net9.0) → Nop.Core, Nop.Data, Nop.Services, Nop.Web.Framework

Reference Modes

  • Full stack (ProjectReference, all 3 libraries) — for nopCommerce plugins that need entity access, data layer, and services.
  • Types only (DLL reference, Mango.Nop.Core only) — for projects that only need DTOs, entities, and interfaces without the nopCommerce runtime dependency.

Documentation Map

File Purpose
.github/copilot-instructions.md Domain rules — single source of truth for all conventions
docs/ARCHITECTURE.md Dependency graph, project roles, DTO strategies, transaction patterns, logging architecture
docs/CONVENTIONS.md Naming, patterns, project boundaries, AyCode integration points
docs/GLOSSARY.md Term definitions — entity/DTO system, data access, services, AyCode types
Mango.Nop.Core/README.md Core project overview — entity hierarchy, loggers, extensions, models
Mango.Nop.Core/docs/DTOS.md DTO system — two mapping strategies, all DTO types, GenericAttribute access
Mango.Nop.Core/docs/NOP_DEPENDENCIES.md NopDependencies pattern — mirror copies, namespace rules, file list
Mango.Nop.Data/README.md Data project overview — repository and context hierarchy, interfaces
Mango.Nop.Data/docs/REPOSITORIES.md MgDbTableBase, MgDtoDbTableBase — CRUD hooks, timestamps, delete rules
Mango.Nop.Data/docs/TRANSACTIONS.md MgDbContextBase — 4 transaction methods, lock strategy, callback contract
Mango.Nop.Services/README.md Services project overview
Mango.Nop.Services/docs/SERVICES.md MgBackgroundServiceBase, MgSessionServiceBase, MgEventConsumerBase, MgLockServiceBase
Mango.Nop.Services/docs/LOGGING_BRIDGE.md NopLogWriter — AyCode-to-nopCommerce log bridge