# carlos-victor/marmitex architecture

> Architecture diagram of the GitHub repository carlos-victor/marmitex, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/carlos-victor/marmitex
- Repository: https://github.com/carlos-victor/marmitex

## Overview

##### Project type and purpose
- This is a Django-based REST API backend (“marmitex”) designed to expose menu data for “marmitárias” (meal-delivery kitchens).
- It does not include a frontend; instead it serves JSON over HTTP to consumers such as mobile apps or web frontends.
- CI/CD is orchestrated via GitHub Actions, with Docker/Herkou for containerized deployment.

##### File structure
- Top level:
- .github/workflows & .github/actions: CI pipelines for testing and deployment
- Dockerfile.heroku, docker-compose.yaml, heroku.yml: container build and cloud deployment config
- source/: contains the Django project (“marmitex”) and three apps: company, menu, utils
- Within source/:
- marmitex/: Django settings, URLs, ASGI/WSGI entrypoints
- company/, menu/, utils/: each is a Django app, with models, migrations, serializers, viewsets (menu), tests
- manage.py and requirements.txt
- There are no separate microservices—everything lives in a single Django process.

##### Main components
a. API Service
- Django application running Gunicorn or Uvicorn (ASGI) inside a Docker container
- Hosts the REST endpoints under URL patterns defined in marmitex/urls.py
b. Database
- A PostgreSQL instance (likely defined in docker-compose.yaml or via Heroku’s managed add-on)
c. Clients
- Mobile or web frontends (external HTTP clients)
d. CI/CD & Infrastructure
- GitHub Actions pipelines (build, test, deploy)
- Docker Registry (optional)
- Heroku or Docker host as production environment
e. (Optional) Cache or Message Broker
- If Redis or Celery is used, add as separate service (not present in file tree by default)

##### Relationships and data flow
- Clients → HTTP request → API Service
- API Service → ORM → Database
- API Service ← GitHub Actions → Docker build → Registry → Deploy to Heroku
- (If using migrations) API Service → run migrations → Database schema changes

##### Architectural patterns and design principles
- Django MVT (Model-View-Template) adapted for API (Model-Serializer-Viewset)
- Separation of concerns by splitting functionality into apps (company, menu, utils)
- Containerization for environment consistency
- Automated pipelines for CI (unit tests in ./tests) and CD (deploy on merge)

##### Relevant technologies, frameworks, libraries
- Python 3.x, Django, Django REST Framework
- Docker, Docker Compose, Heroku
- GitHub Actions
- PostgreSQL
- (Implicit) Gunicorn or Uvicorn

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Clients" 
        Clients["Mobile/Web Clients"] 
    end

    subgraph "Runtime (Backend)" 
        subgraph "Django API Service"
            Settings["settings.py"]
            URLs["urls.py"]
            ASGI["asgi.py"]
            WSGI["wsgi.py"]
            Manage["manage.py"]
            subgraph "Apps"
                Company["company app"]
                Menu["menu app"]
                Utils["utils app"]
            end
        end
        DB[(PostgreSQL DB)]
    end

    subgraph "CI/CD Pipeline"
        GHActions["GitHub Actions"]
        DockerBuild["Docker Build"]
        Registry["Docker Registry"]
        Heroku["Heroku Deploy"]
    end

    Clients -->|"HTTP Request/Response"| URLs
    URLs -->|"routes to"| Company
    URLs -->|"routes to"| Menu
    URLs -->|"routes to"| Utils
    Company -->|ORM| DB
    Menu -->|ORM| DB
    Utils -->|ORM| DB
    Manage -->|migrations| DB

    GHActions --> DockerBuild
    DockerBuild --> Registry
    Registry --> Heroku
    GHActions -->|tests| Company
    GHActions -->|tests| Menu
    GHActions -->|tests| Utils

    click Settings "https://github.com/carlos-victor/marmitex/blob/master/source/marmitex/settings.py"
    click URLs "https://github.com/carlos-victor/marmitex/blob/master/source/marmitex/urls.py"
    click ASGI "https://github.com/carlos-victor/marmitex/blob/master/source/marmitex/asgi.py"
    click WSGI "https://github.com/carlos-victor/marmitex/blob/master/source/marmitex/wsgi.py"
    click Manage "https://github.com/carlos-victor/marmitex/blob/master/source/manage.py"
    click Company "https://github.com/carlos-victor/marmitex/tree/master/source/company/"
    click Company "https://github.com/carlos-victor/marmitex/blob/master/source/company/admin.py"
    click Company "https://github.com/carlos-victor/marmitex/blob/master/source/company/api/serializers.py"
    click Company "https://github.com/carlos-victor/marmitex/blob/master/source/company/models.py"
    click Company "https://github.com/carlos-victor/marmitex/blob/master/source/company/migrations/0001_create_table_company_and_company_user.py"
    click Company "https://github.com/carlos-victor/marmitex/tree/master/source/company/tests/"
    click Menu "https://github.com/carlos-victor/marmitex/tree/master/source/menu/"
    click Menu "https://github.com/carlos-victor/marmitex/blob/master/source/menu/admin.py"
    click Menu "https://github.com/carlos-victor/marmitex/blob/master/source/menu/api/serializers.py"
    click Menu "https://github.com/carlos-victor/marmitex/blob/master/source/menu/api/viewsets.py"
    click Menu "https://github.com/carlos-victor/marmitex/blob/master/source/menu/models.py"
    click Menu "https://github.com/carlos-victor/marmitex/blob/master/source/menu/migrations/0001_create_struct_table_menu.py"
    click Menu "https://github.com/carlos-victor/marmitex/tree/master/source/menu/tests/"
    click Utils "https://github.com/carlos-victor/marmitex/tree/master/source/utils/"
    click Utils "https://github.com/carlos-victor/marmitex/blob/master/source/utils/admin.py"
    click Utils "https://github.com/carlos-victor/marmitex/blob/master/source/utils/models.py"
    click Utils "https://github.com/carlos-victor/marmitex/blob/master/source/utils/signals.py"
    click Utils "https://github.com/carlos-victor/marmitex/blob/master/source/utils/utils.py"
    click Utils "https://github.com/carlos-victor/marmitex/tree/master/source/utils/tests/"
    click DB "https://github.com/carlos-victor/marmitex/blob/master/docker-compose.yaml"
    click DB "https://github.com/carlos-victor/marmitex/blob/master/heroku.yml"
    click DockerBuild "https://github.com/carlos-victor/marmitex/blob/master/Dockerfile.heroku"
    click DockerBuild "https://github.com/carlos-victor/marmitex/tree/master/docker/Dockerfile"
    click DockerBuild "https://github.com/carlos-victor/marmitex/blob/master/docker/entrypoint.sh"
    click GHActions "https://github.com/carlos-victor/marmitex/blob/master/.github/workflows/test.yml"
    click GHActions "https://github.com/carlos-victor/marmitex/blob/master/.github/workflows/deploy-heroku.yml"
    click GHActions "https://github.com/carlos-victor/marmitex/blob/master/.github/actions/action-test/action.yml"
    click GHActions "https://github.com/carlos-victor/marmitex/blob/master/.github/actions/action-deploy/action.yml"

    classDef runtime fill:#e0ffe0,stroke:#333
    classDef cicd fill:#e0e0ff,stroke:#333
    classDef external fill:#eeeeee,stroke:#333
    class Settings,URLs,ASGI,WSGI,Manage,Company,Menu,Utils,DB runtime
    class GHActions,DockerBuild,Registry,Heroku cicd
    class Clients external
```
