AyCode.Core/README.md

4.7 KiB

AyCode.Core Solution

.NET 9 core framework providing serialization (Binary, JSON, Toon), entity abstractions, database access, services, and shared utilities. Used as the foundation layer for AyCode applications.

LLM Context

Domain rules and key pitfalls live in a single file: .github/copilot-instructions.md

Tool Auto-loaded Action needed
GitHub Copilot copilot-instructions.md None
Claude Code CLAUDE.md → references above None
Cursor / Windsurf README.md Read copilot-instructions.md via @file

Solution-level docs in docs/:

Document Topic
GLOSSARY.md Core terminology reference
ARCHITECTURE.md Solution layers, dependency rules
CONVENTIONS.md Coding conventions

Project-level docs — each project's docs/ folder documents the code it defines:

Project Documents
AyCode.Core/docs/ BINARY/ (README, FORMAT, FEATURES, OPTIONS, …), LOGGING/ (README, ISSUES, TODO)
AyCode.Core.Server/docs/ LOGGING/README.md (server-side variant)
AyCode.Services/docs/ SIGNALR/, SIGNALR_BINARY_PROTOCOL/, LOGGING/README.md (remote variant)
AyCode.Services.Server/docs/ SIGNALR/ (README), SIGNALR_DATASOURCE/ (README + ISSUES + TODO)

Solution Structure

Project Purpose README
AyCode.Core Core library: serializers, compression, logging, validation README
AyCode.Core.Server Server-side core extensions (GlobalLogger) README
AyCode.Core.Serializers.SourceGenerator Roslyn source generator for binary serializers README
AyCode.Core.Serializers.Console Serializer benchmark console app README
AyCode.Interfaces Entity interfaces: IId, IForeignKey, profiles, addresses README
AyCode.Interfaces.Server Server-side interfaces (login services) README
AyCode.Entities Abstract entity base classes (User, Profile, Address, Company) README
AyCode.Entities.Server Server-side entities (LogItem) README
AyCode.Models DTOs and view models README
AyCode.Models.Server Server-side models (Login, DynamicMethods) README
AyCode.Services Client-side services (SignalR, logging, login) README
AyCode.Services.Server Server-side services (SignalR hub, email, login) README
AyCode.Database EF Core data access layer with DAL pattern README
AyCode.Utils Zero-dependency utilities (string, datetime, lock wrappers) README
AyCode.Utils.Server Server-side utilities (placeholder) README

Test & Benchmark Projects

Project Purpose README
AyCode.Benchmark BenchmarkDotNet performance suite README
AyCode.Core.Tests Serialization, compression, and utility tests README
AyCode.Core.Tests.Internal Internal entity implementations for DB tests README
AyCode.Database.Tests Database layer test base classes README
AyCode.Database.Tests.Internal Concrete database integration tests README
AyCode.Services.Tests Service layer tests README
AyCode.Services.Server.Tests Server-side SignalR and service tests README