# gonbechii/backend-data-portfolio-2025 architecture

> Architecture diagram of the GitHub repository gonbechii/backend-data-portfolio-2025, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/gonbechii/backend-data-portfolio-2025
- Repository: https://github.com/gonbechii/backend-data-portfolio-2025

## Overview

##### Project Type and Purpose
- This is a monorepo containing two related projects. The focus here is **Project 1 — Orders & Inventory API**, a **backend REST service** built with Django/DRF and MariaDB, intended to manage products, customers, orders (with nested items), stock validation and later expose business metrics to Power BI. It lives alongside a future **ETL/Data Pipeline** and dashboards but currently implements only the API layer.

##### File Structure Analysis
- Top-level files: `.env.db`, `docker-compose.yml` (DB container), README, `docs/`, `seeds/`.
- `orders_inventory_api/`: the Django project root containing
- `config/`: Django settings (`settings.py`), URL router (`urls.py`), WSGI/ASGI.
- `core/`: app modules—`models.py` (Customer, Product, Order, OrderItem), `serializers.py`, `views.py`, `admin.py`, migrations and `tests/`.
- `manage.py`.
- `seeds/`: JSON fixture for products.
- Docker support via `docker-compose.yml` orchestrates MariaDB + Adminer.

##### README Insights
- Describes tech stack: Python 3.13, Django 5.x, DRF, MariaDB, Power BI.
- Outlines functional features (JWT/auth to come, business metrics, CI/CD).
- Lists REST endpoints, usage examples and seed data workflow.
- Roadmap covers future additions (Swagger, Celery, ETL with Pandas, dashboards, CI/CD).

a. Main Components
- Client/UI (cURL/Postman/third-party)
- Django Application
- URL Router & Middleware
- Authentication (JWT, permissions)
- API Views / ViewSets (Customers, Products, Orders)
- Serializers (input validation, nested items)
- Business Logic (order total calculation, stock decrement)
- Database Layer (MariaDB via Django ORM)
- Tables: product, customer, order, order_item
- Data Seed & Migration Tools (manage.py migrations & loaddata)
- External Service
- Adminer (DB admin)
- (Future) Power BI dashboard / ETL pipeline service
- Dev/Infra
- Docker Compose network (db, adminer, app)
- CI/CD pipeline (future GitHub Actions or similar)

b. Relationships & Data Flow
- Client → Django Router (HTTP REST) → Views
- Views ↔ Serializers (validation & conversion)
- Views ↔ ORM → MariaDB
- On order creation: transactional flow that validates stock, creates OrderItem rows, updates Product.stock, recalculates totals.
- (Future) ETL job reads DB → Pandas transforms → loads to analytics DB → Power BI

c. Architectural Patterns
- MVC/MVT: Django separates Models, Views, Templates (no UI templates here, only API).
- Layered Architecture:
1. Presentation/API Layer
2. Business Logic Layer (serializers + model methods)
3. Data Access Layer (ORM)
- Single-service monolith (will evolve into micro-services or separate ETL microservice).

d. Key Technologies & Libraries
- Django + Django REST Framework
- MariaDB/MySQL (dockerized)
- Python-dotenv for env config
- serializers, viewsets, routers (DRF)
- migrations & fixtures for data seeding
- Adminer for DB management
- (Planned) Pandas, Celery, Swagger/OpenAPI

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Clients
    Client["Client (cURL/Postman)"]:::external

    %% Docker Compose Boundary
    subgraph "Docker Compose Network"
        direction TB
        subgraph "App Container"
            direction TB
            subgraph "Django App"
                direction TB
                Config["Django Config\n(settings, URLs, WSGI/ASGI)"]:::api
                Router["URL Router & Middleware"]:::api
                Views["API Views / ViewSets"]:::api
                Serializers["Serializers\n(validation, nested)"]:::api
                ORM["Django ORM"]:::persistence
                Migrations["Migrations & Seeds"]:::persistence
            end
            AdminSite["Django Admin Interface"]:::api
            Manage["Manage.py CLI"]:::api
        end

        DB["MariaDB\n(products, customers, orders, order_items)"]:::persistence
        Adminer["Adminer"]:::external
    end

    %% Future / Roadmap
    subgraph "Future Extensions" 
        direction TB
        ETL["ETL Pipeline (Pandas)"]:::future
        PowerBI["Power BI Dashboard"]:::future
    end

    %% Data Flow
    Client -->|"HTTP REST"| Router
    Router -->|"dispatch"| Views
    Views -->|"serialize/validate"| Serializers
    Serializers -->|"model methods\n(order logic)"| ORM
    ORM -->|"SQL queries"| DB
    DB -->|"query results"| ORM
    Migrations -->|"loaddata\nmanage.py"| DB
    Manage -->|"migrate, loaddata"| Migrations
    AdminSite -->|"DB access"| DB
    Adminer -->|"DB admin UI"| DB

    %% Future Flow
    ETL -.->|"read/write"| DB
    ETL -->|"push metrics"| PowerBI

    %% Click Events
    click Config "https://github.com/gonbechii/backend-data-portfolio-2025/blob/main/orders_inventory_api/config/settings.py"
    click Config "https://github.com/gonbechii/backend-data-portfolio-2025/blob/main/orders_inventory_api/config/urls.py"
    click Config "https://github.com/gonbechii/backend-data-portfolio-2025/blob/main/orders_inventory_api/config/asgi.py"
    click Config "https://github.com/gonbechii/backend-data-portfolio-2025/blob/main/orders_inventory_api/config/wsgi.py"
    click Router "https://github.com/gonbechii/backend-data-portfolio-2025/blob/main/orders_inventory_api/config/urls.py"
    click Views "https://github.com/gonbechii/backend-data-portfolio-2025/blob/main/orders_inventory_api/core/views.py"
    click Serializers "https://github.com/gonbechii/backend-data-portfolio-2025/blob/main/orders_inventory_api/core/serializers.py"
    click ORM "https://github.com/gonbechii/backend-data-portfolio-2025/blob/main/orders_inventory_api/core/models.py"
    click ORM "https://github.com/gonbechii/backend-data-portfolio-2025/blob/main/orders_inventory_api/core/models.py"
    click Migrations "https://github.com/gonbechii/backend-data-portfolio-2025/tree/main/orders_inventory_api/core/migrations/"
    click AdminSite "https://github.com/gonbechii/backend-data-portfolio-2025/blob/main/orders_inventory_api/core/admin.py"
    click Manage "https://github.com/gonbechii/backend-data-portfolio-2025/blob/main/orders_inventory_api/manage.py"
    click Migrations "https://github.com/gonbechii/backend-data-portfolio-2025/blob/main/docker-compose.yml"
    click Migrations "https://github.com/gonbechii/backend-data-portfolio-2025/blob/main/.env.db"
    click Migrations "https://github.com/gonbechii/backend-data-portfolio-2025/blob/main/seeds/products_fixture.json"
    click Client "https://github.com/gonbechii/backend-data-portfolio-2025/tree/main/orders_inventory_api/tests/curl/"
    click Migrations "https://github.com/gonbechii/backend-data-portfolio-2025/blob/main/docs/er.md"
    click Migrations "https://github.com/gonbechii/backend-data-portfolio-2025/blob/main/docs/diario-semana1.md"
    click Migrations "https://github.com/gonbechii/backend-data-portfolio-2025/blob/main/README.md"

    %% Styles
    classDef api fill:#D0E6FF,stroke:#004E9A,color:#000;
    classDef persistence fill:#D0FFD6,stroke:#2D7F2D,color:#000;
    classDef external fill:#F0F0F0,stroke:#666,color:#000;
    classDef future fill:#FFF5CC,stroke:#B8860B,stroke-dasharray:5 5,color:#000;
```
