How caiofugii/sanorte-vistorias-backend works
This is a NestJS REST backend for field inspections. Its main workflow authenticates users, lets authorized staff manage checklists and submit inspections, then handles evidence, signatures, finalization and pending-adjustment resolution; results also feed dashboards and exports. Other product areas cover operational records, reporting and asset uploads. The README documents the broader capabilities; sampled controllers and the SOURCE INDEX establish only some internal calls, so unsampled links are omitted rather than inferred.
Main entry points: asset-storage.interface.ts Asset storage · inspections.controller.ts Inspection API · s3-asset-storage.adapter.ts S3 storage · cloudinary-asset-storage.adapter.ts Cloudinary storage
Components 26
Access & setup
- JWT authentication
src/auth/auth.service.ts - Users
src/users/users.service.ts - Teams
src/teams/teams.service.ts - Sectors
src/sectors/sectors.service.ts - Collaborators
src/collaborators/collaborators.service.ts
Inspection workflow
- Checklists
src/checklists/checklists.service.ts - Inspection API
src/inspections/inspections.controller.ts - Inspection lifecycle
src/inspections/inspections.service.ts - Inspection rules
src/inspections/inspection-domain.service.ts - Offline sync
src/inspections/sync.controller.ts
Operational records
- Contracts
src/contracts/contracts.service.ts - Service orders
src/service-orders/service-orders.service.ts - Investment works
src/investment-works/investment-works.service.ts
Analytics & reporting
- Dashboards
src/dashboards/dashboards.service.ts - Reports
src/reports/reports.service.ts - Excel exports
src/excel/excel.service.ts
Files & storage
- Upload API
src/uploads/uploads.controller.ts - Asset storage
src/storage/asset-storage.interface.ts - Storage provider selection
src/storage/asset-storage.registry.ts - Local storage
src/storage/adapters/local-asset-storage.adapter.ts - S3 storage
src/storage/adapters/s3-asset-storage.adapter.ts - Cloudinary storage
src/storage/adapters/cloudinary-asset-storage.adapter.ts
Other components
- API client
- PostgreSQL
- AWS S3
- Cloudinary
Connections 26
- API client → JWT authentication: logs in
- API client → Inspection API: submits inspections
- Inspection API → Inspection lifecycle: dispatches lifecycle actions
src/inspections/inspections.controller.ts - API client → Checklists: manages checklists
- API client → Offline sync: syncs offline inspections
- API client → Dashboards: requests metrics
- API client → Upload API: uploads assets
- API client → Service orders: manages service orders
- API client → Contracts: manages contracts
- API client → Investment works: manages work
- API client → Reports: requests reports
- API client → Users: manages users
- API client → Teams: manages teams
- API client → Sectors: manages sectors
- API client → Collaborators: manages collaborators
- API client → Excel exports: downloads exports
- Inspection API → Excel exports: attaches export
src/inspections/inspections.controller.ts - API client → PostgreSQL: reads and writes records
- Upload API → Asset storage: uses storage interface
src/uploads/uploads.controller.ts - Checklists → Asset storage: uses storage interface
src/checklists/checklists.service.ts - Asset storage → Storage provider selection: selects provider
src/checklists/checklists.service.ts - Local storage → Asset storage: implements interface
src/storage/adapters/local-asset-storage.adapter.ts - S3 storage → Asset storage: implements interface
src/storage/adapters/s3-asset-storage.adapter.ts - Cloudinary storage → AWS S3: migrates assets
- S3 storage → AWS S3: stores assets
- Cloudinary storage → Cloudinary: stores assets