🏠 Home | 🧭 Guide (EN) | 🛡️ Architecture
🛡️ Architecture & Platform Overview (EN)
This section provides a high-level overview of the architectural patterns and foundational components provided by the codex-core library.
Domain Structure
We divide the platform into three main domains, each serving a specific purpose:
| Domain | Description | Key Components |
|---|---|---|
| 🛡️ Core | Essential data models and security. | BaseDTO, PII Masking, mask_value. |
| 🛠️ Common | Standardized utility functions. | normalize_phone, normalize_name, TaskLogContext. |
| ⚙️ Settings | Infrastructure configuration. | BaseCommonSettings, redis_url. |
Core Principles
- Security First: PII protection is integrated at the base DTO level.
- Immutability: Data models are frozen by default to prevent side effects.
- Standardization: Common tasks (phone, name, logging) are solved once for all Codex projects.
- Developer Friendly: Comprehensive documentation and type hinting ensure a smooth experience.
Next Steps
- Read about 🛡️ Core: PII & DTO.
- Explore 🛠️ Common Utilities.
- Understand ⚙️ Settings Architecture.