# abhishalinibathula-design/niyovara architecture

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

- Interactive diagram: https://gitdiagram.com/abhishalinibathula-design/niyovara
- Repository: https://github.com/abhishalinibathula-design/niyovara

## Overview

Niyovara is a browser-based legal-document explainer. The main workflow is to upload a .txt document or load the fictional sample, segment it into clauses, extract entities, and display plain-language summaries; users can also translate clauses or ask document-grounded questions and jump to cited clauses. The map separates the UI, document analysis, multilingual support, and question answering. The README documents capabilities whose detailed UI code was not sampled, so those links cite the README rather than implying unsampled implementation details were inspected.

Main entry points: [`app/page.tsx`](https://github.com/abhishalinibathula-design/niyovara/blob/main/app/page.tsx) (Document workspace), [`app/api/ask/route.ts`](https://github.com/abhishalinibathula-design/niyovara/blob/main/app/api/ask/route.ts) (Question and translation API), [`lib/i18n.ts`](https://github.com/abhishalinibathula-design/niyovara/blob/main/lib/i18n.ts) (Translations and labels), [`lib/sample.ts`](https://github.com/abhishalinibathula-design/niyovara/blob/main/lib/sample.ts) (Demo document)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_document_ui["Document experience"]
  node_workspace["Document workspace<br/>[page.tsx]"]
  node_sample["Demo document<br/>[sample.ts]"]
  node_source_view["Clause source view<br/>[page.tsx]"]
end

subgraph group_analysis["Document analysis"]
  node_segmentation["Clause segmentation<br/>[analyze.ts]"]
  node_entity_extraction["Entity extraction<br/>[analyze.ts]"]
  node_summaries["Plain-language summaries<br/>[analyze.ts]"]
end

subgraph group_language["Language support"]
  node_language_content["Translations and labels<br/>[i18n.ts]"]
end

subgraph group_qa["Question answering"]
  node_ask_api["Question and translation API<br/>[route.ts]"]
  node_clause_retrieval["Clause retrieval<br/>[analyze.ts]"]
  node_answer_fallback["Grounded fallback answers<br/>[analyze.ts]"]
end

node_user(("Document user"))
node_llm_provider["Optional LLM provider"]

node_user -->|"uploads document"| node_workspace
node_workspace -->|"loads demo"| node_sample
node_workspace -->|"segments text"| node_segmentation
node_workspace -->|"extracts entities"| node_entity_extraction
node_workspace -->|"shows explanations"| node_summaries
node_workspace -->|"uses language content"| node_language_content
node_workspace -->|"sends questions"| node_ask_api
node_workspace -->|"requests translation"| node_ask_api
node_ask_api -->|"retrieves clauses"| node_clause_retrieval
node_ask_api -->|"uses fallback"| node_answer_fallback
node_ask_api -.->|"requests answer or translation"| node_llm_provider
node_ask_api -->|"gets localized headers"| node_language_content
node_user -->|"opens cited clause"| node_source_view

click node_workspace "https://github.com/abhishalinibathula-design/niyovara/blob/main/app/page.tsx"
click node_sample "https://github.com/abhishalinibathula-design/niyovara/blob/main/lib/sample.ts"
click node_source_view "https://github.com/abhishalinibathula-design/niyovara/blob/main/app/page.tsx"
click node_segmentation "https://github.com/abhishalinibathula-design/niyovara/blob/main/lib/analyze.ts"
click node_entity_extraction "https://github.com/abhishalinibathula-design/niyovara/blob/main/lib/analyze.ts"
click node_summaries "https://github.com/abhishalinibathula-design/niyovara/blob/main/lib/analyze.ts"
click node_language_content "https://github.com/abhishalinibathula-design/niyovara/blob/main/lib/i18n.ts"
click node_ask_api "https://github.com/abhishalinibathula-design/niyovara/blob/main/app/api/ask/route.ts"
click node_clause_retrieval "https://github.com/abhishalinibathula-design/niyovara/blob/main/lib/analyze.ts"
click node_answer_fallback "https://github.com/abhishalinibathula-design/niyovara/blob/main/lib/analyze.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_workspace,node_sample,node_source_view,node_user toneBlue
class node_segmentation,node_entity_extraction,node_summaries toneAmber
class node_language_content toneMint
class node_ask_api,node_clause_retrieval,node_answer_fallback toneRose
class node_llm_provider toneIndigo
```

## Components

### Document experience

- [Document workspace](https://github.com/abhishalinibathula-design/niyovara/blob/main/app/page.tsx): `app/page.tsx`
- [Demo document](https://github.com/abhishalinibathula-design/niyovara/blob/main/lib/sample.ts): `lib/sample.ts`
- [Clause source view](https://github.com/abhishalinibathula-design/niyovara/blob/main/app/page.tsx): `app/page.tsx`

### Document analysis

- [Clause segmentation](https://github.com/abhishalinibathula-design/niyovara/blob/main/lib/analyze.ts): `lib/analyze.ts`
- [Entity extraction](https://github.com/abhishalinibathula-design/niyovara/blob/main/lib/analyze.ts): `lib/analyze.ts`
- [Plain-language summaries](https://github.com/abhishalinibathula-design/niyovara/blob/main/lib/analyze.ts): `lib/analyze.ts`

### Language support

- [Translations and labels](https://github.com/abhishalinibathula-design/niyovara/blob/main/lib/i18n.ts): `lib/i18n.ts`

### Question answering

- [Question and translation API](https://github.com/abhishalinibathula-design/niyovara/blob/main/app/api/ask/route.ts): `app/api/ask/route.ts`
- [Clause retrieval](https://github.com/abhishalinibathula-design/niyovara/blob/main/lib/analyze.ts): `lib/analyze.ts`
- [Grounded fallback answers](https://github.com/abhishalinibathula-design/niyovara/blob/main/lib/analyze.ts): `lib/analyze.ts`

### Other components

- **Document user**
- **Optional LLM provider**

## Connections

- Document user → Document workspace: uploads document (evidence: `README.md`)
- Document workspace → Demo document: loads demo (evidence: `app/page.tsx`)
- Document workspace → Clause segmentation: segments text (evidence: `README.md`)
- Document workspace → Entity extraction: extracts entities (evidence: `app/page.tsx`)
- Document workspace → Plain-language summaries: shows explanations (evidence: `app/page.tsx`)
- Document workspace → Translations and labels: uses language content
- Document workspace → Question and translation API: sends questions (evidence: `app/page.tsx`)
- Document workspace → Question and translation API: requests translation (evidence: `README.md`)
- Question and translation API → Clause retrieval: retrieves clauses (evidence: `app/api/ask/route.ts`)
- Question and translation API → Grounded fallback answers: uses fallback (evidence: `app/api/ask/route.ts`)
- Question and translation API → Optional LLM provider: requests answer or translation (evidence: `app/api/ask/route.ts`)
- Question and translation API → Translations and labels: gets localized headers (evidence: `app/api/ask/route.ts`)
- Document user → Clause source view: opens cited clause (evidence: `README.md`)
