Repository Structure¶
Status: Implemented
Overview¶
The Nivron repository is organized around clear functional boundaries rather than technology-specific layers. Each top-level directory represents a distinct responsibility within the platform, allowing the product to evolve without creating unnecessary coupling between components.
The repository is intentionally structured to support long-term growth, modular development and maintainability.
Top-Level Structure¶
| Directory | Purpose |
|---|---|
apps/ |
Executable platform applications. |
platform/ |
Shared platform framework, database and common contracts. |
deploy/ |
Deployment definitions for platform services. |
docs/ |
Project documentation and NVR documents. |
config/ |
Shared platform configuration. |
Applications¶
The apps directory contains the user-facing applications that compose the platform.
| Application | Status | Description |
|---|---|---|
| Control Plane | Implemented | Central platform service and public API. |
| Public Site | Implemented | Corporate website. |
| Documentation | Implemented | Official technical documentation. |
| NVR Edge | Planned | Future execution agent. |
Shared Platform¶
The platform directory contains reusable platform capabilities shared across applications.
| Module | Description |
|---|---|
| Framework | Shared libraries and common services. |
| Database | Database schema and migrations. |
| Contracts | Shared contracts and interfaces. |
Design Philosophy¶
The repository follows a modular architecture based on responsibility separation.
- Applications remain independent.
- Shared code lives inside the platform layer.
- Documentation evolves together with the software.
- Deployment definitions remain isolated from business logic.
Repository Evolution¶
As new capabilities are introduced, they should be added to the appropriate module instead of expanding existing components beyond their responsibilities.
This approach preserves consistency and keeps the repository easy to navigate.
Related Topics¶
- Architecture Overview
- Control Plane
- Platform Framework
Next Step¶
Continue with Control Plane to understand the central service that coordinates the Nivron platform.