How rocketseat-education/05-nest-clean works
This is a NestJS backend API for a Q&A forum. Its principal user workflow is account creation/authentication, posting questions, receiving answers and comments, and selecting a best answer; attachments and read notifications are additional capabilities. The graph reflects the documented API and the sampled module/repository wiring. Most controllers and use cases were not sampled, so their internal call paths are left unverified rather than inferred.
Main entry points: controllers HTTP endpoints · repositories Prisma repositories · use-cases Forum use cases · entities Forum entities
Components 21
HTTP and access
- HTTP endpoints
src/infra/http/controllers - Authentication
src/infra/auth
Forum domain
- Forum use cases
src/domain/forum/application/use-cases - Forum entities
src/domain/forum/enterprise/entities - Forum events
src/domain/forum/enterprise/events - Forum repository contracts
src/domain/forum/application/repositories - Core primitives
src/core
Notifications
- Notification use cases
src/domain/notification/application/use-cases - Event subscribers
src/domain/notification/application/subscribers - Notification entity
src/domain/notification/enterprise/entities/notification.ts - Notification repository contract
src/domain/notification/application/repositories/notifications-repository.ts
Persistence and integrations
- Database wiring
src/infra/database/database.module.ts - Prisma repositories
src/infra/database/prisma/repositories - Prisma client
src/infra/database/prisma/prisma.service.ts - PostgreSQL
- Redis cache
src/infra/cache/redis/redis-cache-repository.ts - Upload service
src/infra/storage/r2-storage.ts - R2 object storage
- Application modules
src/infra/app.module.ts - Event wiring
src/infra/events/events.module.ts
Other components
- Forum user
Connections 23
- Forum user → HTTP endpoints: uses API
README.md - HTTP endpoints → Authentication: authenticates
- HTTP endpoints → Forum use cases: dispatches to
- HTTP endpoints → Notification use cases: dispatches to
- Forum use cases → Forum repository contracts: uses contracts
src/domain/forum/application/use-cases/authenticate-student.ts - Forum use cases → Forum entities: uses entities
- Forum entities → Core primitives: uses primitives
src/domain/forum/enterprise/entities/question.ts - Forum entities → Forum events: raises events
src/domain/forum/enterprise/entities/question.ts - Database wiring → Prisma repositories: binds implementations
src/infra/database/database.module.ts - Database wiring → Prisma client: provides client
src/infra/database/database.module.ts - Prisma repositories → Prisma client: uses client
src/infra/database/prisma/repositories/prisma-questions-repository.ts - Prisma repositories → Forum repository contracts: implements contracts
src/infra/database/database.module.ts - Prisma client → PostgreSQL: persists data
README.md - Prisma repositories → Redis cache: uses cache
src/infra/database/prisma/repositories/prisma-questions-repository.ts - Event subscribers → Forum events: handles events
- Event subscribers → Notification use cases: triggers notification
- Notification use cases → Notification repository contract: uses contract
- Notification repository contract → Notification entity: stores entity
src/domain/notification/application/repositories/notifications-repository.ts - Notification repository contract → Prisma repositories: implemented by
src/infra/database/database.module.ts - Forum use cases → Upload service: requests uploads
- Upload service → R2 object storage: uploads objects
src/infra/storage/r2-storage.ts - Application modules → HTTP endpoints: registers module
src/infra/app.module.ts - Application modules → Event wiring: registers module
src/infra/app.module.ts