Added comprehensive README.md documentation to every project and subfolder in the solution. Each README describes the purpose, key files, structure, dependencies, and design patterns for its area. This improves codebase navigability and maintainability, and includes a maintenance note to keep docs in sync with future code changes. |
||
|---|---|---|
| .. | ||
| Logins | ||
| AyCode.Interfaces.Server.csproj | ||
| README.md | ||
README.md
AyCode.Interfaces.Server
Server-side interface contracts extending AyCode.Interfaces. Defines authentication and login service contracts that are only relevant on the server.
Key Files
Logins/
IAcLoginDtoBase.cs— Empty marker interface for login DTOs.IAcLoggedInModelBase.cs— Generic interface for the logged-in user model. Properties:IsLoggedIn,LoggedInUser,AccessToken,LoginErrorCode. Methods:AddLoggedInUser(),Logout(). Heavily constrained generics (TUser,TUserToken,TProfile,TCompany,TUserToServiceProvider,TProfileAddress).IAcLoginServiceServer.cs— Server-side login service extendingIAcLoginServiceCommon. Adds:Login()/LoginAsync()(returnsTResultLoggedInModel),UpdatePassword(). ReturnsAcErrorCodefor validation.
Dependencies
| Dependency | Purpose |
|---|---|
AyCode.Interfaces |
Base interface contracts (users, profiles, companies, logins) |
AyCode.Core |
Error codes (AcErrorCode) |
AyCode.Core.Server |
Server-side core |
AyCode.Entities |
Entity base classes |
AyCode.Entities.Server |
Server-side entities |
LLM Maintenance: If you modify code in this folder, update this README to reflect the changes. If you notice the README content does not match the current code, automatically update the README to match the code.