# mshahilt/aadhar-ocr-server architecture

> Architecture diagram of the GitHub repository mshahilt/aadhar-ocr-server, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mshahilt/aadhar-ocr-server
- Repository: https://github.com/mshahilt/aadhar-ocr-server

## Overview

This is an Express API for extracting Aadhaar details from front- and back-side images. A client submits both images to the process-image endpoint; upload middleware stores them temporarily, and the controller runs OCR, parses each side, combines the results, returns JSON, then removes the temporary files. Parsing includes front-side identity fields and back-side address cleanup. The graph follows the sampled route and controller code; database connection is commented out in the server, so no active persistence flow is shown.

Main entry points: [`src/controllers/user.controller.ts`](https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/controllers/user.controller.ts) (Image controller), [`src/routes/user.routes.ts`](https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/routes/user.routes.ts) (User routes), [`src/utils/extractback.ts`](https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/utils/extractback.ts) (Back-side parser), [`src/app.ts`](https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/app.ts) (Express app)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["API runtime"]
  node_server["HTTP server<br/>[server.ts]"]
  node_app["Express app<br/>[app.ts]"]
  node_routes["User routes<br/>[user.routes.ts]"]
  node_async["Async wrapper<br/>[asyncHandler.ts]"]
end

subgraph group_ocr["Image processing"]
  node_upload["Disk upload<br/>[multer.ts]"]
  node_controller["Image controller<br/>[user.controller.ts]"]
  node_tesseract["Tesseract OCR"]
end

subgraph group_parsing["Aadhaar parsing"]
  node_front["Front-side parser<br/>[extractText.ts]"]
  node_back["Back-side parser<br/>[extractback.ts]"]
  node_clean["Address cleaner<br/>[cleanAddress.ts]"]
end

subgraph group_contracts["Shared data"]
  node_contract["Aadhaar data type<br/>[IAadhar.ts]"]
end

node_client(("API client"))

node_client -->|"submits images"| node_routes
node_server -->|"starts"| node_app
node_app -->|"mounts routes"| node_routes
node_routes -->|"stores uploads"| node_upload
node_routes -->|"wraps handler"| node_async
node_async -->|"invokes"| node_controller
node_controller -->|"runs OCR"| node_tesseract
node_controller -->|"parses front text"| node_front
node_controller -->|"parses back text"| node_back
node_back -->|"cleans address"| node_clean
node_front -->|"returns typed data"| node_contract
node_back -->|"returns typed data"| node_contract
node_controller -->|"returns JSON"| node_client

click node_server "https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/server.ts"
click node_app "https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/app.ts"
click node_routes "https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/routes/user.routes.ts"
click node_async "https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/utils/asyncHandler.ts"
click node_upload "https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/utils/multer.ts"
click node_controller "https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/controllers/user.controller.ts"
click node_front "https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/utils/extractText.ts"
click node_back "https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/utils/extractback.ts"
click node_clean "https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/utils/cleanAddress.ts"
click node_contract "https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/interfaces/IAadhar.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_server,node_app,node_routes,node_async,node_client toneBlue
class node_upload,node_controller,node_tesseract toneAmber
class node_front,node_back,node_clean toneMint
class node_contract toneRose
```

## Components

### API runtime

- [HTTP server](https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/server.ts): `src/server.ts`
- [Express app](https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/app.ts): `src/app.ts`
- [User routes](https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/routes/user.routes.ts): `src/routes/user.routes.ts`
- [Async wrapper](https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/utils/asyncHandler.ts): `src/utils/asyncHandler.ts`

### Image processing

- [Disk upload](https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/utils/multer.ts): `src/utils/multer.ts`
- [Image controller](https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/controllers/user.controller.ts): `src/controllers/user.controller.ts`
- **Tesseract OCR**

### Aadhaar parsing

- [Front-side parser](https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/utils/extractText.ts): `src/utils/extractText.ts`
- [Back-side parser](https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/utils/extractback.ts): `src/utils/extractback.ts`
- [Address cleaner](https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/utils/cleanAddress.ts): `src/utils/cleanAddress.ts`

### Shared data

- [Aadhaar data type](https://github.com/mshahilt/aadhar-ocr-server/blob/main/src/interfaces/IAadhar.ts): `src/interfaces/IAadhar.ts`

### Other components

- **API client**

## Connections

- API client → User routes: submits images (evidence: `src/routes/user.routes.ts`)
- HTTP server → Express app: starts (evidence: `src/server.ts`)
- Express app → User routes: mounts routes (evidence: `src/app.ts`)
- User routes → Disk upload: stores uploads (evidence: `src/routes/user.routes.ts`)
- User routes → Async wrapper: wraps handler (evidence: `src/routes/user.routes.ts`)
- Async wrapper → Image controller: invokes (evidence: `src/routes/user.routes.ts`)
- Image controller → Tesseract OCR: runs OCR (evidence: `src/controllers/user.controller.ts`)
- Image controller → Front-side parser: parses front text (evidence: `src/controllers/user.controller.ts`)
- Image controller → Back-side parser: parses back text (evidence: `src/controllers/user.controller.ts`)
- Back-side parser → Address cleaner: cleans address (evidence: `src/utils/extractback.ts`)
- Front-side parser → Aadhaar data type: returns typed data (evidence: `src/utils/extractText.ts`)
- Back-side parser → Aadhaar data type: returns typed data (evidence: `src/utils/extractback.ts`)
- Image controller → API client: returns JSON (evidence: `src/controllers/user.controller.ts`)
