How kwamegilbert/nframa works
Nframa is a fixed-route ride-platform API: riders and drivers use admin-defined corridors and scheduled trips, with supporting identity, verification, wallet/payment, safety, review, and notification capabilities. The main request flow is HTTP routing through validation/authentication into controllers, which coordinate domain models and services backed by PostgreSQL. The graph includes README-documented capabilities whose implementation was not sampled; those branches are shown at subsystem level. Source excerpts and index references support the depicted internal links; unsampled details are omitted rather than inferred.
Main entry points: index.ts Route registry · trip.controller.ts Trip lifecycle · BaseModel.ts Domain models · review.controller.ts Trip reviews
Components 24
API and access
- HTTP API
src/app.ts - Route registry
src/routes/index.ts - Authentication
src/middlewares/authenticate.ts - Permission checks
src/middlewares/authorize.ts - Request validation
src/middlewares/validate.ts - Error responses
src/middlewares/errorHandler.ts
Ride operations
- Driver commutes
src/controllers/driverCommute.controller.ts - Trip lifecycle
src/controllers/trip.controller.ts - Fare calculation
src/services/fare.service.ts - Route estimates
src/services/maps.service.ts - Trip records
src/models/trip.model.ts - Trip reviews
src/controllers/review.controller.ts - SOS incidents
src/controllers/sosIncident.controller.ts
Accounts and trust
- Sign-in and sessions
src/controllers/auth.controller.ts - User management
src/controllers/user.controller.ts - Driver verification
src/controllers/verification.controller.ts
Data and services
- Wallet and payments
src/services/wallet.service.ts - Notifications
src/services/notification.service.ts - Socket events
src/services/socket.service.ts - Activity audit
src/services/activityLog.service.ts - Domain models
src/models/BaseModel.ts - PostgreSQL
Other components
- Riders and drivers
- Paystack
Connections 31
- Riders and drivers → HTTP API: uses
- HTTP API → Route registry: mounts routes
src/app.ts - Route registry → Trip lifecycle: routes trips
- Route registry → Sign-in and sessions: routes auth
- Route registry → User management: routes users
- Route registry → Driver verification: routes verification
- Route registry → Trip reviews: routes reviews
- Route registry → Driver commutes: routes commutes
- Route registry → SOS incidents: routes SOS
- Route registry → Authentication: applies authentication
- Route registry → Request validation: validates requests
- Trip lifecycle → Permission checks: checks permissions
src/controllers/trip.controller.ts - Permission checks → Domain models: queries role permissions
src/middlewares/authorize.ts - Trip lifecycle → Trip records: manages trips
src/controllers/trip.controller.ts - Trip lifecycle → Driver commutes: loads commutes
src/controllers/trip.controller.ts - Trip lifecycle → Fare calculation: uses fares
src/controllers/trip.controller.ts - Trip lifecycle → Route estimates: requests route
src/controllers/trip.controller.ts - Trip lifecycle → Socket events: emits trip events
src/controllers/trip.controller.ts - Trip lifecycle → Activity audit: records activity
src/controllers/trip.controller.ts - Trip reviews → Trip records: loads trip
src/controllers/review.controller.ts - Trip reviews → Activity audit: records activity
src/controllers/review.controller.ts - Trip reviews → User management: finds user
src/controllers/review.controller.ts - Sign-in and sessions → Domain models: uses account models
src/controllers/auth.controller.ts - User management → Domain models: uses user models
src/controllers/user.controller.ts - Driver verification → Domain models: uses verification models
src/controllers/verification.controller.ts - Driver verification → Notifications: sends notices
src/controllers/verification.controller.ts - User management → Activity audit: records activity
src/controllers/user.controller.ts - Domain models → PostgreSQL: reads and writes
src/models/BaseModel.ts - Trip records → Fare calculation: uses fare logic
src/models/trip.model.ts - Wallet and payments → Paystack: processes payments
- HTTP API → Error responses: handles errors
src/app.ts