How sagarsishir51/nestjs-hexagonal-architecture-demo-project works
This is a NestJS hexagonal-architecture API for authentication and user, role, and privilege management, with file upload support. The main workflow is an API request through a controller and use case, with persistence adapters backed by TypeORM; the sampled user controller and module show the controller and dependency wiring, but use-case/repository internals were not sampled. The README also documents database seeding, migrations, and Swagger. Dashed edges mark documented or likely relationships whose implementation wiring is not visible in the excerpts.
Main entry points: user.module.ts User module wiring · app.module.ts Nest app setup · user.controller.ts User API · role.controller.ts Role API
Components 29
API and security
- User API
src/frameworks/primary/controllers/user/user.controller.ts - Role API
src/frameworks/primary/controllers/role/role.controller.ts - Privilege API
src/frameworks/primary/controllers/privilege/privilege.controller.ts - Auth API
src/frameworks/primary/controllers/auth/auth.controller.ts - Upload API
src/frameworks/primary/controllers/upload/upload.controller.ts - Request security
src/frameworks/primary/guards/privilege.guard.ts - JWT strategy
src/frameworks/primary/strategies/jwt.strategy.ts
Application and domain
- User use case
src/core/application/usecases/user/user.usecase.ts - Role use case
src/core/application/usecases/role/role.usecase.ts - Privilege use case
src/core/application/usecases/privilege/privilege.usecase.ts - Auth use case
src/core/application/usecases/auth/auth.usecase.ts - User domain
src/core/domain/user/user.domain.ts - Role domain
src/core/domain/role/role.domain.ts - Privilege domain
src/core/domain/privilege/privilege.domain.ts
Persistence
- User repository
src/frameworks/secondary/user/user.repository.ts - Role repository
src/frameworks/secondary/role/role.repository.ts - Privilege repository
src/frameworks/secondary/privilege/privilege.repository.ts - User entity
src/frameworks/secondary/user/user.entity.ts - Role entity
src/frameworks/secondary/role/role.entity.ts - Privilege entity
src/frameworks/secondary/privilege/privilege.entity.ts - Seed data
src/seeders/privilege.seeder.ts
Runtime and integrations
- Nest app setup
src/app.module.ts - User module wiring
src/modules/user/user.module.ts - Auth module
src/modules/auth/auth.module.ts - Upload module
src/modules/upload/upload.module.ts - TypeORM configuration
src/infrastructure/database/typeorm.service.ts - Upload storage
src/utils/upload.ts
Other components
- API client
- Relational database
Connections 44
- API client → User API: requests
src/frameworks/primary/controllers/user/user.controller.ts - API client → Role API: requests
src/frameworks/primary/controllers/role/role.controller.ts - API client → Privilege API: requests
src/frameworks/primary/controllers/privilege/privilege.controller.ts - API client → Auth API: requests
src/frameworks/primary/controllers/auth/auth.controller.ts - API client → Upload API: requests
- User API → User use case: invokes
src/frameworks/primary/controllers/user/user.controller.ts - Role API → Role use case: invokes
src/frameworks/primary/controllers/role/role.controller.ts - Privilege API → Privilege use case: invokes
src/frameworks/primary/controllers/privilege/privilege.controller.ts - Auth API → Auth use case: invokes
src/frameworks/primary/controllers/auth/auth.controller.ts - User API → User domain: constructs
src/frameworks/primary/controllers/user/user.controller.ts - Role API → Role domain: constructs
src/frameworks/primary/controllers/role/role.controller.ts - User API → Request security: requires privilege
- Role API → Request security: requires privilege
- Privilege API → Request security: requires privilege
- Nest app setup → User module wiring: loads
src/app.module.ts - Nest app setup → Auth module: loads
src/app.module.ts - Nest app setup → Upload module: loads
src/app.module.ts - Nest app setup → TypeORM configuration: configures
src/app.module.ts - Nest app setup → Request security: registers guard
src/app.module.ts - Auth module → User module wiring: imports
src/modules/auth/auth.module.ts - User module wiring → User API: registers
src/modules/user/user.module.ts - User module wiring → Role API: registers
src/modules/user/user.module.ts - User module wiring → Privilege API: registers
src/modules/user/user.module.ts - User module wiring → User use case: binds
src/modules/user/user.module.ts - User module wiring → Role use case: binds
src/modules/user/user.module.ts - User module wiring → Privilege use case: binds
src/modules/user/user.module.ts - User module wiring → User repository: binds
src/modules/user/user.module.ts - User module wiring → Role repository: binds
src/modules/user/user.module.ts - User module wiring → Privilege repository: binds
src/modules/user/user.module.ts - User module wiring → User entity: registers
src/modules/user/user.module.ts - User module wiring → Role entity: registers
src/modules/user/user.module.ts - User module wiring → Privilege entity: registers
src/modules/user/user.module.ts - User repository → User entity: uses
src/frameworks/secondary/user/user.repository.ts - Role repository → Role entity: uses
src/frameworks/secondary/role/role.repository.ts - Privilege repository → Privilege entity: uses
src/frameworks/secondary/privilege/privilege.repository.ts - Role entity → Privilege entity: relates
src/frameworks/secondary/role/role.entity.ts - User entity → Role entity: relates
src/frameworks/secondary/user/user.entity.ts - TypeORM configuration → Relational database: connects
- User repository → User use case: implements port
- Role repository → Role use case: implements port
- Privilege repository → Privilege use case: implements port
- Auth API → JWT strategy: authenticates via
- Upload API → Upload storage: stores files
- Seed data → Relational database: populates