# pendeks/software-engineering-project architecture

> Architecture diagram of the GitHub repository pendeks/software-engineering-project, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/pendeks/software-engineering-project
- Repository: https://github.com/pendeks/software-engineering-project

## Overview

DocuMind is the active product: a workspace-scoped document intelligence service with a React interface, asynchronous document processing, and cited RAG answers. Users create workspaces, upload documents, wait for processing, then ask questions and receive answers with citations. The graph also includes the documented FlowDesk product as a separate implemented portfolio project; DeployFlow has no runtime source in the supplied tree. Source excerpts are partial, so some subsystem boundaries are represented only where the source index or README supports them.

Main entry points: [`documind/src/documind/api.py`](https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/api.py) (REST API), [`documind/src/documind/processing.py`](https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/processing.py) (Document processing), [`documind/src/documind/worker.py`](https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/worker.py) (Job worker), [`documind/src/documind/embeddings.py`](https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/embeddings.py) (Embedding provider)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_docu_ui["DocuMind interface"]
  node_web_app["DocuMind app<br/>[App.tsx]"]
  node_web_api["API client<br/>[api.ts]"]
end

subgraph group_docu_api["DocuMind service"]
  node_api["REST API<br/>[api.py]"]
  node_config["Settings<br/>[config.py]"]
  node_validation["Upload validation"]
end

subgraph group_docu_pipeline["Document pipeline"]
  node_worker["Job worker<br/>[worker.py]"]
  node_processing["Document processing<br/>[processing.py]"]
  node_embeddings["Embedding provider<br/>[embeddings.py]"]
  node_answering["Answer generation<br/>[answering.py]"]
  node_retrieval["Source retrieval<br/>[retrieval.py]"]
end

subgraph group_docu_data["Persistence"]
  node_models["Domain models<br/>[models.py]"]
  node_database["Database setup<br/>[database.py]"]
  node_file_storage["Local file storage<br/>[storage.py]"]
  node_sql_store[("SQL database")]
  node_disk[("Local filesystem")]
end

subgraph group_flowdesk["FlowDesk"]
  node_flowdesk_app["FlowDesk platform<br/>[server.ts]"]
end

node_user(("Workspace user"))
node_azure_openai{{"Azure OpenAI"}}
node_flow_user(("FlowDesk user"))

node_user -->|"uses"| node_web_app
node_web_app -->|"requests"| node_web_api
node_web_api -.->|"calls"| node_api
node_api -->|"loads"| node_config
node_api -->|"creates sessions"| node_database
node_api -->|"validates uploads"| node_validation
node_api -->|"stores files"| node_file_storage
node_api -->|"persists metadata"| node_models
node_api -->|"answers questions"| node_answering
node_api -->|"embeds questions"| node_embeddings
node_api -->|"queues jobs"| node_processing
node_worker -->|"loads"| node_config
node_worker -->|"initializes"| node_database
node_worker -->|"processes jobs"| node_processing
node_worker -->|"provides storage"| node_file_storage
node_worker -->|"provides embeddings"| node_embeddings
node_processing -->|"reads documents"| node_file_storage
node_processing -.->|"embeds chunks"| node_embeddings
node_processing -->|"writes chunks"| node_models
node_processing -.->|"extracts validated content"| node_validation
node_answering -->|"retrieves sources"| node_retrieval
node_answering -->|"embeds question"| node_embeddings
node_answering -->|"generates answer"| node_azure_openai
node_embeddings -->|"requests vectors"| node_azure_openai
node_retrieval -->|"queries chunks"| node_models
node_models -->|"uses base"| node_database
node_database -->|"initializes"| node_sql_store
node_file_storage -->|"reads and writes"| node_disk
node_flow_user -->|"uses"| node_flowdesk_app

click node_web_app "https://github.com/pendeks/software-engineering-project/blob/main/documind/web/src/App.tsx"
click node_web_api "https://github.com/pendeks/software-engineering-project/blob/main/documind/web/src/api.ts"
click node_api "https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/api.py"
click node_config "https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/config.py"
click node_validation "https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/document_validation.py"
click node_worker "https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/worker.py"
click node_processing "https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/processing.py"
click node_embeddings "https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/embeddings.py"
click node_answering "https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/answering.py"
click node_retrieval "https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/retrieval.py"
click node_models "https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/models.py"
click node_database "https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/database.py"
click node_file_storage "https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/storage.py"
click node_flowdesk_app "https://github.com/pendeks/software-engineering-project/blob/main/flowdesk/src/server.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_web_app,node_web_api,node_user,node_flow_user toneBlue
class node_api,node_config,node_validation toneAmber
class node_worker,node_processing,node_embeddings,node_answering,node_retrieval toneMint
class node_models,node_database,node_file_storage,node_sql_store,node_disk toneRose
class node_flowdesk_app,node_azure_openai toneIndigo
```

## Components

### DocuMind interface

- [DocuMind app](https://github.com/pendeks/software-engineering-project/blob/main/documind/web/src/App.tsx): `documind/web/src/App.tsx`
- [API client](https://github.com/pendeks/software-engineering-project/blob/main/documind/web/src/api.ts): `documind/web/src/api.ts`

### DocuMind service

- [REST API](https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/api.py): `documind/src/documind/api.py`
- [Settings](https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/config.py): `documind/src/documind/config.py`
- [Upload validation](https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/document_validation.py): `documind/src/documind/document_validation.py`

### Document pipeline

- [Job worker](https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/worker.py): `documind/src/documind/worker.py`
- [Document processing](https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/processing.py): `documind/src/documind/processing.py`
- [Embedding provider](https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/embeddings.py): `documind/src/documind/embeddings.py`
- [Answer generation](https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/answering.py): `documind/src/documind/answering.py`
- [Source retrieval](https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/retrieval.py): `documind/src/documind/retrieval.py`

### Persistence

- [Domain models](https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/models.py): `documind/src/documind/models.py`
- [Database setup](https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/database.py): `documind/src/documind/database.py`
- [Local file storage](https://github.com/pendeks/software-engineering-project/blob/main/documind/src/documind/storage.py): `documind/src/documind/storage.py`
- **SQL database**
- **Local filesystem**

### FlowDesk

- [FlowDesk platform](https://github.com/pendeks/software-engineering-project/blob/main/flowdesk/src/server.ts): `flowdesk/src/server.ts`

### Other components

- **Workspace user**
- **Azure OpenAI**
- **FlowDesk user**

## Connections

- Workspace user → DocuMind app: uses (evidence: `documind/web/src/App.tsx`)
- DocuMind app → API client: requests (evidence: `documind/web/src/App.tsx`)
- API client → REST API: calls
- REST API → Settings: loads (evidence: `documind/src/documind/api.py`)
- REST API → Database setup: creates sessions (evidence: `documind/src/documind/api.py`)
- REST API → Upload validation: validates uploads (evidence: `documind/src/documind/api.py`)
- REST API → Local file storage: stores files (evidence: `documind/src/documind/api.py`)
- REST API → Domain models: persists metadata (evidence: `documind/src/documind/api.py`)
- REST API → Answer generation: answers questions (evidence: `documind/src/documind/api.py`)
- REST API → Embedding provider: embeds questions (evidence: `documind/src/documind/api.py`)
- REST API → Document processing: queues jobs (evidence: `documind/src/documind/api.py`)
- Job worker → Settings: loads (evidence: `documind/src/documind/worker.py`)
- Job worker → Database setup: initializes (evidence: `documind/src/documind/worker.py`)
- Job worker → Document processing: processes jobs (evidence: `documind/src/documind/worker.py`)
- Job worker → Local file storage: provides storage (evidence: `documind/src/documind/worker.py`)
- Job worker → Embedding provider: provides embeddings (evidence: `documind/src/documind/worker.py`)
- Document processing → Local file storage: reads documents (evidence: `documind/src/documind/processing.py`)
- Document processing → Embedding provider: embeds chunks (evidence: `documind/src/documind/embeddings.py`)
- Document processing → Domain models: writes chunks (evidence: `documind/src/documind/processing.py`)
- Document processing → Upload validation: extracts validated content (evidence: `documind/src/documind/processing.py`)
- Answer generation → Source retrieval: retrieves sources (evidence: `documind/src/documind/answering.py`)
- Answer generation → Embedding provider: embeds question (evidence: `documind/src/documind/answering.py`)
- Answer generation → Azure OpenAI: generates answer (evidence: `documind/src/documind/answering.py`)
- Embedding provider → Azure OpenAI: requests vectors (evidence: `documind/src/documind/embeddings.py`)
- Source retrieval → Domain models: queries chunks (evidence: `documind/src/documind/retrieval.py`)
- Domain models → Database setup: uses base (evidence: `documind/src/documind/models.py`)
- Database setup → SQL database: initializes (evidence: `documind/src/documind/database.py`)
- Local file storage → Local filesystem: reads and writes (evidence: `documind/src/documind/storage.py`)
- FlowDesk user → FlowDesk platform: uses (evidence: `README.md`)
