Skip to content

Commit 5c4ab5d

Browse files
committed
docs: add demo section with YouTube link and architecture diagram to README
1 parent 4a7ce00 commit 5c4ab5d

File tree

2 files changed

+138
-539
lines changed

2 files changed

+138
-539
lines changed

README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ An AI‑powered financial intelligence platform for detecting and investigating
2222

2323
</div>
2424

25+
## Demo
26+
27+
Watch the demo on YouTube: [https://youtu.be/r_G-eIlJKkU](https://youtu.be/r_G-eIlJKkU)
28+
2529
## Overview
2630

2731
Project NETRA provides a unified workflow for ingesting datasets (CSV/ZIP), calculating hybrid risk scores, inspecting networks, and generating AI‑assisted PDF reports. It ships with synthetic datasets and lets investigators upload data from the UI.
@@ -36,6 +40,56 @@ Highlights:
3640

3741
## Architecture
3842

43+
Below is a high-level architecture and request flow for NETRA:
44+
45+
```mermaid
46+
flowchart LR
47+
%% Client Layer
48+
subgraph Client
49+
U[User]
50+
FE[Frontend (React + Vite)]
51+
end
52+
53+
%% Backend API and Services
54+
subgraph Backend[Backend (Flask API)]
55+
API[/REST: /api/*/]
56+
RS[risk_scoring.py]
57+
RG[report_generator.py]
58+
GA[graph_analysis.py]
59+
CM[case_manager.py]
60+
AS[ai_summarizer.py]
61+
end
62+
63+
%% Data Sources
64+
subgraph Data[Data Sources]
65+
CSV[(CSV files\nbackend/generated-data)]
66+
NEO[(Neo4j\noptional)]
67+
FS[(Firestore\noptional)]
68+
end
69+
70+
%% Client -> API
71+
U -->|actions| FE
72+
FE -->|Fetch JSON/PDF| API
73+
FE -->|Upload ZIP/CSV| API
74+
75+
%% API -> Services
76+
API --> RS
77+
API --> RG
78+
API --> GA
79+
API --> CM
80+
API --> AS
81+
82+
%% Services <-> Data
83+
RS <--> CSV
84+
GA --> NEO
85+
CM <--> FS
86+
RS -->|AlertScores.csv| CSV
87+
88+
%% Responses
89+
RG -->|PDF| FE
90+
API -->|JSON| FE
91+
```
92+
3993
Backend (Flask):
4094
- Data loader with schema validation (CSVs under `backend/generated-data/`).
4195
- Risk scoring (`services/risk_scoring.py`), AI summarizer, report generator, optional graph analyzer.

0 commit comments

Comments
 (0)