# shivamkumarsing/society-management-api architecture

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

- Interactive diagram: https://gitdiagram.com/shivamkumarsing/society-management-api
- Repository: https://github.com/shivamkumarsing/society-management-api

## Overview

This is a NestJS TypeScript backend for managing users, societies, subscriptions, revenue, announcements, and administrative dashboards. Its user-facing flow is HTTP request → controller → feature service → database where shown; login additionally looks up a user and issues a JWT. Dashboard operations include reporting and a transactional society setup that creates an admin and subscription. The README is only the Nest starter template, so product capabilities are inferred from the source tree and sampled files. Some feature internals are unsampled; their connections are included only where the source index supports them.

Main entry points: [`src/app.module.ts`](https://github.com/shivamkumarsing/society-management-api/blob/main/src/app.module.ts) (Application composition), [`src/dashboard/dashboard.controller.ts`](https://github.com/shivamkumarsing/society-management-api/blob/main/src/dashboard/dashboard.controller.ts) (Dashboard API), [`src/subscriptions/subscriptions.controller.ts`](https://github.com/shivamkumarsing/society-management-api/blob/main/src/subscriptions/subscriptions.controller.ts) (Subscriptions API), [`src/auth/auth.controller.ts`](https://github.com/shivamkumarsing/society-management-api/blob/main/src/auth/auth.controller.ts) (Authentication API)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_security["Access and identity"]
  node_auth_api["Authentication API<br/>[auth.controller.ts]"]
  node_auth_service["Authentication service<br/>[auth.service.ts]"]
  node_jwt_guard["JWT guard<br/>[jwt-auth.guard.ts]"]
  node_roles_guard["Role guard<br/>[roles.guard.ts]"]
  node_role_decorator["Role metadata<br/>[roles.decorator.ts]"]
end

subgraph group_people["Users and societies"]
  node_users_api["Users API"]
  node_users_service["Users service<br/>[users.service.ts]"]
  node_societies_api["Societies API"]
  node_societies_service["Societies service"]
end

subgraph group_operations["Service operations"]
  node_bootstrap["Application bootstrap<br/>[main.ts]"]
  node_app["Application composition<br/>[app.module.ts]"]
  node_subscriptions_api["Subscriptions API"]
  node_subscriptions_service["Subscriptions service"]
  node_announcements_api["Announcements API"]
  node_announcements_service["Announcements service"]
  node_logs_api["Logs API<br/>[logs.controller.ts]"]
  node_logs_service["Logs service<br/>[logs.service.ts]"]
end

subgraph group_insights["Administrative insights"]
  node_dashboard_api["Dashboard API"]
  node_dashboard_service["Dashboard service"]
  node_revenue_api["Revenue API"]
  node_revenue_service["Revenue service<br/>[revenue.service.ts]"]
end

subgraph group_models["Domain models"]
  node_user_model["User entity<br/>[users.entity.ts]"]
  node_role_model["Role entity<br/>[role.entity.ts]"]
  node_society_model["Society entities"]
  node_subscription_model["Subscription entity"]
end

node_http(("HTTP clients"))
node_postgres[("PostgreSQL")]

node_http -->|"requests"| node_auth_api
node_http -->|"requests"| node_users_api
node_http -->|"requests"| node_societies_api
node_http -->|"requests"| node_dashboard_api
node_http -->|"requests"| node_revenue_api
node_http -->|"requests"| node_subscriptions_api
node_http -->|"requests"| node_announcements_api
node_bootstrap -->|"bootstraps"| node_app
node_app -->|"registers module"| node_auth_api
node_app -->|"registers module"| node_users_api
node_app -->|"registers module"| node_dashboard_api
node_app -->|"registers module"| node_societies_api
node_app -->|"registers module"| node_subscriptions_api
node_app -->|"registers module"| node_revenue_api
node_app -->|"registers module"| node_announcements_api
node_app -->|"registers module"| node_logs_api
node_app -->|"configures"| node_postgres
node_auth_api -->|"calls"| node_auth_service
node_auth_service -->|"looks up user"| node_users_service
node_users_api -->|"calls"| node_users_service
node_societies_api -->|"calls"| node_societies_service
node_dashboard_api -->|"calls"| node_dashboard_service
node_revenue_api -->|"calls"| node_revenue_service
node_subscriptions_api -->|"calls"| node_subscriptions_service
node_announcements_api -->|"calls"| node_announcements_service
node_logs_api -->|"calls"| node_logs_service
node_dashboard_api -->|"guards routes"| node_jwt_guard
node_dashboard_api -->|"guards routes"| node_roles_guard
node_dashboard_api -->|"sets role policy"| node_role_decorator
node_subscriptions_api -->|"guards routes"| node_jwt_guard
node_subscriptions_api -->|"guards routes"| node_roles_guard
node_auth_api -.->|"authenticates via"| node_postgres
node_users_service -->|"queries"| node_postgres
node_dashboard_service -->|"queries and writes"| node_postgres
node_dashboard_service -->|"saves"| node_subscription_model
node_user_model -->|"references"| node_role_model

click node_bootstrap "https://github.com/shivamkumarsing/society-management-api/blob/main/src/main.ts"
click node_app "https://github.com/shivamkumarsing/society-management-api/blob/main/src/app.module.ts"
click node_auth_api "https://github.com/shivamkumarsing/society-management-api/blob/main/src/auth/auth.controller.ts"
click node_auth_service "https://github.com/shivamkumarsing/society-management-api/blob/main/src/auth/auth.service.ts"
click node_jwt_guard "https://github.com/shivamkumarsing/society-management-api/blob/main/src/auth/jwt-auth.guard.ts"
click node_roles_guard "https://github.com/shivamkumarsing/society-management-api/blob/main/src/auth/roles.guard.ts"
click node_role_decorator "https://github.com/shivamkumarsing/society-management-api/blob/main/src/auth/roles.decorator.ts"
click node_users_api "https://github.com/shivamkumarsing/society-management-api/blob/main/src/users/users.controller.ts"
click node_users_service "https://github.com/shivamkumarsing/society-management-api/blob/main/src/users/users.service.ts"
click node_societies_api "https://github.com/shivamkumarsing/society-management-api/blob/main/src/societies/societies.controller.ts"
click node_societies_service "https://github.com/shivamkumarsing/society-management-api/blob/main/src/societies/societies.service.ts"
click node_dashboard_api "https://github.com/shivamkumarsing/society-management-api/blob/main/src/dashboard/dashboard.controller.ts"
click node_dashboard_service "https://github.com/shivamkumarsing/society-management-api/blob/main/src/dashboard/dashboard.service.ts"
click node_revenue_api "https://github.com/shivamkumarsing/society-management-api/blob/main/src/revenue/revenue.controller.ts"
click node_revenue_service "https://github.com/shivamkumarsing/society-management-api/blob/main/src/revenue/revenue.service.ts"
click node_subscriptions_api "https://github.com/shivamkumarsing/society-management-api/blob/main/src/subscriptions/subscriptions.controller.ts"
click node_subscriptions_service "https://github.com/shivamkumarsing/society-management-api/blob/main/src/subscriptions/subscriptions.service.ts"
click node_announcements_api "https://github.com/shivamkumarsing/society-management-api/blob/main/src/announcements/announcements.controller.ts"
click node_announcements_service "https://github.com/shivamkumarsing/society-management-api/blob/main/src/announcements/announcements.service.ts"
click node_logs_api "https://github.com/shivamkumarsing/society-management-api/blob/main/src/logs/logs.controller.ts"
click node_logs_service "https://github.com/shivamkumarsing/society-management-api/blob/main/src/logs/logs.service.ts"
click node_user_model "https://github.com/shivamkumarsing/society-management-api/blob/main/src/users/users.entity.ts"
click node_role_model "https://github.com/shivamkumarsing/society-management-api/blob/main/src/roles/role.entity.ts"
click node_society_model "https://github.com/shivamkumarsing/society-management-api/blob/main/src/societies/society-entities.ts"
click node_subscription_model "https://github.com/shivamkumarsing/society-management-api/blob/main/src/subscriptions/subscription.entity.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_auth_api,node_auth_service,node_jwt_guard,node_roles_guard,node_role_decorator,node_http toneBlue
class node_users_api,node_users_service,node_societies_api,node_societies_service,node_postgres toneAmber
class node_bootstrap,node_app,node_subscriptions_api,node_subscriptions_service,node_announcements_api,node_announcements_service,node_logs_api,node_logs_service toneMint
class node_dashboard_api,node_dashboard_service,node_revenue_api,node_revenue_service toneRose
class node_user_model,node_role_model,node_society_model,node_subscription_model toneIndigo
```

## Components

### Access and identity

- [Authentication API](https://github.com/shivamkumarsing/society-management-api/blob/main/src/auth/auth.controller.ts): `src/auth/auth.controller.ts`
- [Authentication service](https://github.com/shivamkumarsing/society-management-api/blob/main/src/auth/auth.service.ts): `src/auth/auth.service.ts`
- [JWT guard](https://github.com/shivamkumarsing/society-management-api/blob/main/src/auth/jwt-auth.guard.ts): `src/auth/jwt-auth.guard.ts`
- [Role guard](https://github.com/shivamkumarsing/society-management-api/blob/main/src/auth/roles.guard.ts): `src/auth/roles.guard.ts`
- [Role metadata](https://github.com/shivamkumarsing/society-management-api/blob/main/src/auth/roles.decorator.ts): `src/auth/roles.decorator.ts`

### Users and societies

- [Users API](https://github.com/shivamkumarsing/society-management-api/blob/main/src/users/users.controller.ts): `src/users/users.controller.ts`
- [Users service](https://github.com/shivamkumarsing/society-management-api/blob/main/src/users/users.service.ts): `src/users/users.service.ts`
- [Societies API](https://github.com/shivamkumarsing/society-management-api/blob/main/src/societies/societies.controller.ts): `src/societies/societies.controller.ts`
- [Societies service](https://github.com/shivamkumarsing/society-management-api/blob/main/src/societies/societies.service.ts): `src/societies/societies.service.ts`

### Service operations

- [Application bootstrap](https://github.com/shivamkumarsing/society-management-api/blob/main/src/main.ts): `src/main.ts`
- [Application composition](https://github.com/shivamkumarsing/society-management-api/blob/main/src/app.module.ts): `src/app.module.ts`
- [Subscriptions API](https://github.com/shivamkumarsing/society-management-api/blob/main/src/subscriptions/subscriptions.controller.ts): `src/subscriptions/subscriptions.controller.ts`
- [Subscriptions service](https://github.com/shivamkumarsing/society-management-api/blob/main/src/subscriptions/subscriptions.service.ts): `src/subscriptions/subscriptions.service.ts`
- [Announcements API](https://github.com/shivamkumarsing/society-management-api/blob/main/src/announcements/announcements.controller.ts): `src/announcements/announcements.controller.ts`
- [Announcements service](https://github.com/shivamkumarsing/society-management-api/blob/main/src/announcements/announcements.service.ts): `src/announcements/announcements.service.ts`
- [Logs API](https://github.com/shivamkumarsing/society-management-api/blob/main/src/logs/logs.controller.ts): `src/logs/logs.controller.ts`
- [Logs service](https://github.com/shivamkumarsing/society-management-api/blob/main/src/logs/logs.service.ts): `src/logs/logs.service.ts`

### Administrative insights

- [Dashboard API](https://github.com/shivamkumarsing/society-management-api/blob/main/src/dashboard/dashboard.controller.ts): `src/dashboard/dashboard.controller.ts`
- [Dashboard service](https://github.com/shivamkumarsing/society-management-api/blob/main/src/dashboard/dashboard.service.ts): `src/dashboard/dashboard.service.ts`
- [Revenue API](https://github.com/shivamkumarsing/society-management-api/blob/main/src/revenue/revenue.controller.ts): `src/revenue/revenue.controller.ts`
- [Revenue service](https://github.com/shivamkumarsing/society-management-api/blob/main/src/revenue/revenue.service.ts): `src/revenue/revenue.service.ts`

### Domain models

- [User entity](https://github.com/shivamkumarsing/society-management-api/blob/main/src/users/users.entity.ts): `src/users/users.entity.ts`
- [Role entity](https://github.com/shivamkumarsing/society-management-api/blob/main/src/roles/role.entity.ts): `src/roles/role.entity.ts`
- [Society entities](https://github.com/shivamkumarsing/society-management-api/blob/main/src/societies/society-entities.ts): `src/societies/society-entities.ts`
- [Subscription entity](https://github.com/shivamkumarsing/society-management-api/blob/main/src/subscriptions/subscription.entity.ts): `src/subscriptions/subscription.entity.ts`

### Other components

- **HTTP clients**
- **PostgreSQL**

## Connections

- HTTP clients → Authentication API: requests (evidence: `src/auth/auth.controller.ts`)
- HTTP clients → Users API: requests (evidence: `src/users/users.controller.ts`)
- HTTP clients → Societies API: requests (evidence: `src/societies/societies.controller.ts`)
- HTTP clients → Dashboard API: requests (evidence: `src/dashboard/dashboard.controller.ts`)
- HTTP clients → Revenue API: requests (evidence: `src/revenue/revenue.controller.ts`)
- HTTP clients → Subscriptions API: requests (evidence: `src/subscriptions/subscriptions.controller.ts`)
- HTTP clients → Announcements API: requests (evidence: `src/announcements/announcements.controller.ts`)
- Application bootstrap → Application composition: bootstraps (evidence: `src/main.ts`)
- Application composition → Authentication API: registers module (evidence: `src/app.module.ts`)
- Application composition → Users API: registers module (evidence: `src/app.module.ts`)
- Application composition → Dashboard API: registers module (evidence: `src/app.module.ts`)
- Application composition → Societies API: registers module (evidence: `src/app.module.ts`)
- Application composition → Subscriptions API: registers module (evidence: `src/app.module.ts`)
- Application composition → Revenue API: registers module (evidence: `src/app.module.ts`)
- Application composition → Announcements API: registers module (evidence: `src/app.module.ts`)
- Application composition → Logs API: registers module (evidence: `src/app.module.ts`)
- Application composition → PostgreSQL: configures (evidence: `src/app.module.ts`)
- Authentication API → Authentication service: calls (evidence: `src/auth/auth.controller.ts`)
- Authentication service → Users service: looks up user (evidence: `src/auth/auth.service.ts`)
- Users API → Users service: calls (evidence: `src/users/users.controller.ts`)
- Societies API → Societies service: calls (evidence: `src/societies/societies.controller.ts`)
- Dashboard API → Dashboard service: calls (evidence: `src/dashboard/dashboard.controller.ts`)
- Revenue API → Revenue service: calls (evidence: `src/revenue/revenue.controller.ts`)
- Subscriptions API → Subscriptions service: calls (evidence: `src/subscriptions/subscriptions.controller.ts`)
- Announcements API → Announcements service: calls (evidence: `src/announcements/announcements.controller.ts`)
- Logs API → Logs service: calls (evidence: `src/logs/logs.controller.ts`)
- Dashboard API → JWT guard: guards routes (evidence: `src/dashboard/dashboard.controller.ts`)
- Dashboard API → Role guard: guards routes (evidence: `src/dashboard/dashboard.controller.ts`)
- Dashboard API → Role metadata: sets role policy (evidence: `src/dashboard/dashboard.controller.ts`)
- Subscriptions API → JWT guard: guards routes (evidence: `src/subscriptions/subscriptions.controller.ts`)
- Subscriptions API → Role guard: guards routes (evidence: `src/subscriptions/subscriptions.controller.ts`)
- Authentication API → PostgreSQL: authenticates via
- Users service → PostgreSQL: queries (evidence: `src/users/users.service.ts`)
- Dashboard service → PostgreSQL: queries and writes (evidence: `src/dashboard/dashboard.service.ts`)
- Dashboard service → Subscription entity: saves (evidence: `src/dashboard/dashboard.service.ts`)
- User entity → Role entity: references (evidence: `src/users/users.entity.ts`)
