How shivamkumarsing/society-management-api works
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: app.module.ts Application composition · dashboard.controller.ts Dashboard API · subscriptions.controller.ts Subscriptions API · auth.controller.ts Authentication API
Components 27
Access and identity
- Authentication API
src/auth/auth.controller.ts - Authentication service
src/auth/auth.service.ts - JWT guard
src/auth/jwt-auth.guard.ts - Role guard
src/auth/roles.guard.ts - Role metadata
src/auth/roles.decorator.ts
Users and societies
- Users API
src/users/users.controller.ts - Users service
src/users/users.service.ts - Societies API
src/societies/societies.controller.ts - Societies service
src/societies/societies.service.ts
Service operations
- Application bootstrap
src/main.ts - Application composition
src/app.module.ts - Subscriptions API
src/subscriptions/subscriptions.controller.ts - Subscriptions service
src/subscriptions/subscriptions.service.ts - Announcements API
src/announcements/announcements.controller.ts - Announcements service
src/announcements/announcements.service.ts - Logs API
src/logs/logs.controller.ts - Logs service
src/logs/logs.service.ts
Administrative insights
- Dashboard API
src/dashboard/dashboard.controller.ts - Dashboard service
src/dashboard/dashboard.service.ts - Revenue API
src/revenue/revenue.controller.ts - Revenue service
src/revenue/revenue.service.ts
Domain models
- User entity
src/users/users.entity.ts - Role entity
src/roles/role.entity.ts - Society entities
src/societies/society-entities.ts - Subscription entity
src/subscriptions/subscription.entity.ts
Other components
- HTTP clients
- PostgreSQL
Connections 36
- HTTP clients → Authentication API: requests
src/auth/auth.controller.ts - HTTP clients → Users API: requests
src/users/users.controller.ts - HTTP clients → Societies API: requests
src/societies/societies.controller.ts - HTTP clients → Dashboard API: requests
src/dashboard/dashboard.controller.ts - HTTP clients → Revenue API: requests
src/revenue/revenue.controller.ts - HTTP clients → Subscriptions API: requests
src/subscriptions/subscriptions.controller.ts - HTTP clients → Announcements API: requests
src/announcements/announcements.controller.ts - Application bootstrap → Application composition: bootstraps
src/main.ts - Application composition → Authentication API: registers module
src/app.module.ts - Application composition → Users API: registers module
src/app.module.ts - Application composition → Dashboard API: registers module
src/app.module.ts - Application composition → Societies API: registers module
src/app.module.ts - Application composition → Subscriptions API: registers module
src/app.module.ts - Application composition → Revenue API: registers module
src/app.module.ts - Application composition → Announcements API: registers module
src/app.module.ts - Application composition → Logs API: registers module
src/app.module.ts - Application composition → PostgreSQL: configures
src/app.module.ts - Authentication API → Authentication service: calls
src/auth/auth.controller.ts - Authentication service → Users service: looks up user
src/auth/auth.service.ts - Users API → Users service: calls
src/users/users.controller.ts - Societies API → Societies service: calls
src/societies/societies.controller.ts - Dashboard API → Dashboard service: calls
src/dashboard/dashboard.controller.ts - Revenue API → Revenue service: calls
src/revenue/revenue.controller.ts - Subscriptions API → Subscriptions service: calls
src/subscriptions/subscriptions.controller.ts - Announcements API → Announcements service: calls
src/announcements/announcements.controller.ts - Logs API → Logs service: calls
src/logs/logs.controller.ts - Dashboard API → JWT guard: guards routes
src/dashboard/dashboard.controller.ts - Dashboard API → Role guard: guards routes
src/dashboard/dashboard.controller.ts - Dashboard API → Role metadata: sets role policy
src/dashboard/dashboard.controller.ts - Subscriptions API → JWT guard: guards routes
src/subscriptions/subscriptions.controller.ts - Subscriptions API → Role guard: guards routes
src/subscriptions/subscriptions.controller.ts - Authentication API → PostgreSQL: authenticates via
- Users service → PostgreSQL: queries
src/users/users.service.ts - Dashboard service → PostgreSQL: queries and writes
src/dashboard/dashboard.service.ts - Dashboard service → Subscription entity: saves
src/dashboard/dashboard.service.ts - User entity → Role entity: references
src/users/users.entity.ts