# jeevansurya560-arch/finneas architecture

> Architecture diagram of the GitHub repository jeevansurya560-arch/finneas, 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/jeevansurya560-arch/finneas
- Repository: https://github.com/jeevansurya560-arch/finneas

## Overview

Finneas is intended to be a private, real-time study room for small groups. The sampled implementation currently provides a React status page that polls a NestJS health endpoint; the README describes broader V1 study-room capabilities, but the tree and excerpts do not show their implementation. Those capabilities are included as documented, unverified subsystems rather than presented as working runtime flows.

Main entry points: [`apps/api/src/main.ts`](https://github.com/jeevansurya560-arch/finneas/blob/main/apps/api/src/main.ts) (NestJS application), [`README.md`](https://github.com/jeevansurya560-arch/finneas/blob/main/README.md) (Private rooms), [`apps/web/src/App.tsx`](https://github.com/jeevansurya560-arch/finneas/blob/main/apps/web/src/App.tsx) (Status page), [`apps/web/src/main.tsx`](https://github.com/jeevansurya560-arch/finneas/blob/main/apps/web/src/main.tsx) (React entry)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_web["Web client"]
  node_webapp["Status page<br/>[App.tsx]"]
  node_webentry["React entry<br/>[main.tsx]"]
end

subgraph group_api["API foundation"]
  node_apiapp["NestJS application<br/>[main.ts]"]
  node_module["App module<br/>[app.module.ts]"]
  node_health["Health endpoint"]
  node_postgres[("PostgreSQL")]
  node_redis[("Redis")]
end

subgraph group_rooms["Room collaboration"]
  node_auth["Email and JWT auth<br/>[README.md]"]
  node_private["Private rooms<br/>[README.md]"]
  node_invites["Room invitations<br/>[README.md]"]
  node_chat["Real-time chat<br/>[README.md]"]
  node_presence["Online presence<br/>[README.md]"]
  node_resources["Resource sharing<br/>[README.md]"]
end

subgraph group_study["Study workflows"]
  node_sessions["Study sessions<br/>[README.md]"]
  node_timer["Shared timer<br/>[README.md]"]
  node_history["Session history<br/>[README.md]"]
end

node_member(("Study group member"))

node_member -.->|"opens"| node_webentry
node_webentry -->|"renders"| node_webapp
node_webapp -->|"polls health"| node_health
node_apiapp -->|"creates"| node_module
node_module -->|"registers"| node_health
node_apiapp -.->|"serves API"| node_webapp
node_apiapp -.->|"persists state"| node_postgres
node_apiapp -.->|"uses presence"| node_redis
node_member -.->|"authenticates"| node_auth
node_member -.->|"creates or joins"| node_private
node_private -.->|"invites members"| node_invites
node_member -.->|"exchanges messages"| node_chat
node_private -.->|"shows members"| node_presence
node_member -.->|"shares links"| node_resources
node_member -.->|"tracks activity"| node_sessions
node_member -.->|"controls timer"| node_timer
node_sessions -.->|"records sessions"| node_history

click node_webapp "https://github.com/jeevansurya560-arch/finneas/blob/main/apps/web/src/App.tsx"
click node_webentry "https://github.com/jeevansurya560-arch/finneas/blob/main/apps/web/src/main.tsx"
click node_apiapp "https://github.com/jeevansurya560-arch/finneas/blob/main/apps/api/src/main.ts"
click node_module "https://github.com/jeevansurya560-arch/finneas/blob/main/apps/api/src/app.module.ts"
click node_health "https://github.com/jeevansurya560-arch/finneas/blob/main/apps/api/src/health/health.controller.ts"
click node_auth "https://github.com/jeevansurya560-arch/finneas/blob/main/README.md"
click node_private "https://github.com/jeevansurya560-arch/finneas/blob/main/README.md"
click node_invites "https://github.com/jeevansurya560-arch/finneas/blob/main/README.md"
click node_chat "https://github.com/jeevansurya560-arch/finneas/blob/main/README.md"
click node_presence "https://github.com/jeevansurya560-arch/finneas/blob/main/README.md"
click node_resources "https://github.com/jeevansurya560-arch/finneas/blob/main/README.md"
click node_sessions "https://github.com/jeevansurya560-arch/finneas/blob/main/README.md"
click node_timer "https://github.com/jeevansurya560-arch/finneas/blob/main/README.md"
click node_history "https://github.com/jeevansurya560-arch/finneas/blob/main/README.md"

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_webapp,node_webentry toneBlue
class node_apiapp,node_module,node_health,node_postgres,node_redis toneAmber
class node_auth,node_private,node_invites,node_chat,node_presence,node_resources toneMint
class node_sessions,node_timer,node_history toneRose
class node_member toneIndigo
```

## Components

### Web client

- [Status page](https://github.com/jeevansurya560-arch/finneas/blob/main/apps/web/src/App.tsx): `apps/web/src/App.tsx`
- [React entry](https://github.com/jeevansurya560-arch/finneas/blob/main/apps/web/src/main.tsx): `apps/web/src/main.tsx`

### API foundation

- [NestJS application](https://github.com/jeevansurya560-arch/finneas/blob/main/apps/api/src/main.ts): `apps/api/src/main.ts`
- [App module](https://github.com/jeevansurya560-arch/finneas/blob/main/apps/api/src/app.module.ts): `apps/api/src/app.module.ts`
- [Health endpoint](https://github.com/jeevansurya560-arch/finneas/blob/main/apps/api/src/health/health.controller.ts): `apps/api/src/health/health.controller.ts`
- **PostgreSQL**
- **Redis**

### Room collaboration

- [Email and JWT auth](https://github.com/jeevansurya560-arch/finneas/blob/main/README.md): `README.md`
- [Private rooms](https://github.com/jeevansurya560-arch/finneas/blob/main/README.md): `README.md`
- [Room invitations](https://github.com/jeevansurya560-arch/finneas/blob/main/README.md): `README.md`
- [Real-time chat](https://github.com/jeevansurya560-arch/finneas/blob/main/README.md): `README.md`
- [Online presence](https://github.com/jeevansurya560-arch/finneas/blob/main/README.md): `README.md`
- [Resource sharing](https://github.com/jeevansurya560-arch/finneas/blob/main/README.md): `README.md`

### Study workflows

- [Study sessions](https://github.com/jeevansurya560-arch/finneas/blob/main/README.md): `README.md`
- [Shared timer](https://github.com/jeevansurya560-arch/finneas/blob/main/README.md): `README.md`
- [Session history](https://github.com/jeevansurya560-arch/finneas/blob/main/README.md): `README.md`

### Other components

- **Study group member**

## Connections

- Study group member → React entry: opens
- React entry → Status page: renders (evidence: `apps/web/src/main.tsx`)
- Status page → Health endpoint: polls health (evidence: `apps/web/src/App.tsx`)
- NestJS application → App module: creates (evidence: `apps/api/src/main.ts`)
- App module → Health endpoint: registers (evidence: `apps/api/src/app.module.ts`)
- NestJS application → Status page: serves API (evidence: `README.md`)
- NestJS application → PostgreSQL: persists state (evidence: `README.md`)
- NestJS application → Redis: uses presence (evidence: `README.md`)
- Study group member → Email and JWT auth: authenticates (evidence: `README.md`)
- Study group member → Private rooms: creates or joins (evidence: `README.md`)
- Private rooms → Room invitations: invites members (evidence: `README.md`)
- Study group member → Real-time chat: exchanges messages (evidence: `README.md`)
- Private rooms → Online presence: shows members (evidence: `README.md`)
- Study group member → Resource sharing: shares links (evidence: `README.md`)
- Study group member → Study sessions: tracks activity (evidence: `README.md`)
- Study group member → Shared timer: controls timer (evidence: `README.md`)
- Study sessions → Session history: records sessions (evidence: `README.md`)
