How brocoders/nestjs-boilerplate works
This repository is a NestJS REST API boilerplate. Its main workflow accepts email or social sign-in, validates credentials or provider identity, then uses user and session services to issue JWT and refresh-token responses; registration and account confirmation also use mailing. Admin user endpoints provide a separate management path. The README documents dual database backends, seeding, roles, translations, and local/S3 uploads. The graph preserves those capabilities, but the source excerpts do not expose every implementation or all runtime wiring, so some documented subsystem links are dashed and unverified.
Main entry points: app.module.ts Nest application · auth.service.ts Auth workflow · files.service.ts File management · auth-google.controller.ts Social endpoints
Components 29
Application runtime
- Nest application
src/app.module.ts - Configuration
src/config/config.type.ts - Translations
src/app.module.ts
Identity and access
- Auth endpoints
src/auth/auth.controller.ts - Auth workflow
src/auth/auth.service.ts - Social endpoints
src/auth-google/auth-google.controller.ts - Apple identity
src/auth-apple/auth-apple.service.ts - Facebook identity
src/auth-facebook/auth-facebook.service.ts - Google identity
src/auth-google/auth-google.service.ts - JWT strategies
src/auth/strategies/jwt.strategy.ts - Role authorization
src/roles/roles.guard.ts
Accounts and persistence
- User endpoints
src/users/users.controller.ts - User service
src/users/users.service.ts - User persistence
src/users/infrastructure/persistence/user.repository.ts - Session service
src/session/session.service.ts - Session persistence
src/session/infrastructure/persistence/session.repository.ts - Database adapters
src/database/typeorm-config.service.ts - Database seeding
src/database/seeds
Product capabilities
- Mail workflows
src/mail/mail.service.ts - Mailer transport
src/mailer/mailer.service.ts - File management
src/files/files.service.ts - Local uploads
src/files/infrastructure/uploader/local/files.service.ts - S3 uploads
src/files/infrastructure/uploader/s3/files.service.ts - Presigned uploads
src/files/infrastructure/uploader/s3-presigned/files.service.ts - File persistence
src/files/infrastructure/persistence/file.repository.ts
Other components
- API clients
- Social providers
- Mail transport
- S3 storage
Connections 32
- API clients → Nest application: sends requests
- Nest application → Configuration: loads settings
src/app.module.ts - Nest application → Translations: configures translations
src/app.module.ts - Nest application → Auth endpoints: registers
src/app.module.ts - Nest application → User endpoints: registers
src/app.module.ts - Auth endpoints → Auth workflow: delegates
src/auth/auth.controller.ts - Auth endpoints → Session service: refreshes sessions
- Auth workflow → User service: looks up users
src/auth/auth.service.ts - Auth workflow → Session service: creates sessions
src/auth/auth.service.ts - Auth workflow → Mail workflows: sends account mail
src/auth/auth.service.ts - Auth workflow → JWT strategies: issues tokens
- Social endpoints → Google identity: verifies identity
src/auth-google/auth-google.controller.ts - Social endpoints → Auth workflow: starts sign-in
src/auth-google/auth-google.controller.ts - Social endpoints → Apple identity: routes Apple login
- Social endpoints → Facebook identity: routes Facebook login
- Google identity → Social providers: verifies token
- Facebook identity → Social providers: requests profile
src/auth-facebook/auth-facebook.service.ts - User endpoints → User service: delegates
src/users/users.controller.ts - User endpoints → Role authorization: checks access
src/users/users.controller.ts - User service → User persistence: reads and writes
src/users/users.service.ts - User service → File management: uses file service
src/users/users.service.ts - Session service → Session persistence: delegates persistence
src/session/session.service.ts - Nest application → Database adapters: selects backend
src/app.module.ts - Nest application → Database seeding: provides seeding
README.md - Mail workflows → Mailer transport: sends mail
src/mail/mail.service.ts - Mailer transport → Mail transport: delivers messages
- File management → File persistence: uses persistence
- File management → Local uploads: supports local driver
README.md - File management → S3 uploads: supports S3 driver
README.md - File management → Presigned uploads: offers presigned uploads
- S3 uploads → S3 storage: stores objects
README.md - Presigned uploads → S3 storage: uses signed access