Project Structure Reference

This section describes the standard folder and file structure used across the project, including documentation, operational assets, and domain-specific resources.

docs/                                       # Central documentation hub for the entire project
├── about.md                                # [Required] About section with public/private links to technical and functional documentation, ownership info
│   |                                       # All code in production must be documented, at least including the location of its repository (Azure DevOps / Github).
│   |                                       # The about.md content must be exposed through a runtime-accessible endpoint or page,
│   |                                       # enabling identification of the component, ownership, repositories, and documentation links.
├── app/                                    # main folder.
│   ├── common/                             # Common Layer class library.
│   │   ├── constants.py                    # Definition of global variables.
│   │   └── messages.py                     # System messages to be used by all methods.
│   ├── core/                               # Definition of base configurations.
│   │   └── config.py                       # Defining environment variables as loading environment variables.
│   ├── routers/                            # The path operations related to your users separated from the rest of the code, to keep it organized.
│   │   ├── default.py                      # Method for responding to a 200 request without taking any action or displaying the information about.
│   │   ├── health.py                       # Methods to monitor health behavior.
│   │   ├── redis.py                        # Methods to monitor redis.
│   │   └── task.py                         # Methods to crud tasks.
│   ├── services/                           # Controller Layer / Business logic (including CRUD helpers).
│   │   ├── constants.py                    # Definition of global variables.
│   │   ├── health.py                       # Health rules.
│   │   ├── redis.py                        # Methods to monitor redis.
│   │   └── task.py                         # Methods to crud tasks.
│
├── DataEngineer/                           # Data management, schemas, and their rollback.
│   ├── migrations/                         # Logical and conceptual system architecture
│   │   ├── backup.sh                       # Backup script console or SQL
│   │   └── restore.sh                      # Restore script console or SQL
│   ├── seeds/                              # Initial data
│   │   └── init-db.sh                      # Script to load baseline seed data
│   └── reference-architecture.md           # Reference patterns, principles, and architectural decisions
│
├── overview/                               # High-level and stable documentation (architecture-focused)
│   ├── architecture.md                     # Logical and conceptual system architecture
│   └── reference-architecture.md           # Reference patterns, principles, and architectural decisions
│
├── guides/                                 # Practical, step-by-step guides for using and operating the project
│   ├── getting-started/                    # Initial setup guides for environments and systems
│   │   └── os-package-managers.md          # OS/Docker/VM package installation and base system dependencies
│   │
│   └── software-development/               # Local development, build, and testing workflows
│       ├── vscode.md                       # VSCode extensions, settings, and workspace configuration
│       ├── launch-and-debug.md             # launch.json, debugging profiles, and local execution configs
│       └── local-scripts.md                # PowerShell/Bash scripts to build, test, and run locally
│
├── troubleshooting/                        # Operational issue resolution and diagnostics
│   └── logging.md                          # Logging strategy, log levels, correlation IDs, and troubleshooting guidance
│
├── governance/                             # Project-wide rules, standards, and policies
│   ├── license.md                          # Explanation of the project license and usage constraints
│   ├── contributing.md                     # Contribution rules, PR process, and development workflow
│   ├── nomenclature-conventions.md         # Official naming conventions for files, folders, and artifacts
│   └── technology-lifecycle.md             # Every component MUST declare its Technology Lifecycle
│
├── files/                                  # Binary and visual assets referenced by documentation
│   ├── architecture.pdf                    # Exported architecture diagrams (read-only)
│   └── architecture.drawio                 # Editable architecture diagrams (source files)
│
├── Ops/                                    # Binary and visual assets referenced by documentation
│   ├── docker-and-semantic-versioning.md   # Docker usage guidelines and semantic versioning strategy
│   └── docker-compose.yml                  # Main Docker Compose configuration file
│
├──.dockerignore                            # Docker ignore rules
├──.env                                     # Local environment variables (never committed)
├──.env.sample                              # Environment variable template
├──.gitignore                               # Git ignore rules
├── CHANGELOG.md                            # Versioned log of notable changes.
├── entrypoint.sh                           # Defining the executable that the container will use.
├── main.py                                 # Startup code.
└── README.md                               # Entry point for documentation; explains structure and where to start by role