How updpujan/task-reminder-system works
Task Reminder System is an Express API for user authentication, task lifecycle management, and timezone-aware reminders, with administrator views and health checks. The main workflow is client → route and authorization → controller → application service → repository → PostgreSQL; the reminder worker separately polls due reminders and advances recurring schedules. Swagger UI is also served by the application. Relationships are based on excerpts, SOURCE INDEX references, and README diagrams; some route/controller and worker wiring is documented rather than fully sampled.
Main entry points: app.ts Express application · databaseConnection.ts PostgreSQL pool · adminRoute.ts Admin routes · TaskController.ts Task controller
Components 26
HTTP API
- Express application
src/app.ts - Task routes
src/Routes/tasksRoute.ts - Auth routes
src/Routes/authRoute.ts - Admin routes
src/Routes/adminRoute.ts - Health route
src/Routes/healthRoute.ts - Swagger UI
src/config/swagger.ts
Identity & Access
- Auth controller
src/controller/authController.ts - Auth services
src/application/auth - JWT middleware
src/middleware/authMiddleware.ts - Admin authorization
src/middleware/adminAuthMiddleware.ts - JWT utilities
src/utils/jwt.ts
Task Management
- Task controller
src/controller/TaskController.ts - Task schemas
src/schema/task - Task services
src/application/task/taskServices.ts - Task repository
src/repository/tasks/taskRepo.ts - User administration
src/controller/userController.ts
Reminder Processing
- Reminder scheduler
src/jobs/reminderSchedular.ts - Reminder service
src/application/reminder/reminderService.ts - Reminder repository
src/repository/reminder.ts - Timezone calculations
src/utils/reminder.ts
Persistence & Health
- Health controller
src/controller/healthController.ts - User repositories
src/repository/users - Authentication repositories
src/repository/auth - PostgreSQL pool
src/config/databaseConnection.ts
Other components
- API client
- PostgreSQL
Connections 31
- API client → Express application: sends HTTP
README.md - Express application → Task routes: mounts routes
src/app.ts - Express application → Auth routes: mounts routes
src/app.ts - Express application → Admin routes: mounts routes
src/app.ts - Express application → Health route: mounts routes
src/app.ts - Express application → Swagger UI: serves UI
src/app.ts - Task routes → JWT middleware: guards requests
src/Routes/tasksRoute.ts - Task routes → Task controller: dispatches requests
src/Routes/tasksRoute.ts - Task controller → Task schemas: validates input
src/controller/TaskController.ts - Task controller → Task services: calls services
src/controller/TaskController.ts - Task services → Task repository: calls repository
src/application/task/taskServices.ts - Task services → Timezone calculations: calculates schedule
src/application/task/taskServices.ts - Auth routes → Auth controller: dispatches requests
src/Routes/authRoute.ts - Auth controller → Auth services: calls services
src/controller/authController.ts - Auth services → Authentication repositories: queries users
src/application/auth/loginService.ts - Auth services → JWT utilities: generates token
src/application/auth/loginService.ts - Auth routes → JWT middleware: applies validation
src/Routes/authRoute.ts - Admin routes → JWT middleware: requires identity
src/Routes/adminRoute.ts - Admin routes → Admin authorization: checks role
src/Routes/adminRoute.ts - Admin routes → Task controller: dispatches task views
src/Routes/adminRoute.ts - Admin routes → User administration: dispatches user views
src/Routes/adminRoute.ts - Health route → Health controller: dispatches check
src/Routes/healthRoute.ts - Health controller → PostgreSQL pool: checks connection
src/controller/healthController.ts - Reminder scheduler → Reminder service: runs periodically
src/jobs/reminderSchedular.ts - Reminder service → Reminder repository: loads and updates
src/application/reminder/reminderService.ts - Reminder service → Timezone calculations: calculates recurrence
src/application/reminder/reminderService.ts - Task repository → PostgreSQL pool: uses pool
src/repository/tasks/taskRepo.ts - Authentication repositories → PostgreSQL pool: uses pool
src/repository/auth/findUser.ts - User repositories → PostgreSQL pool: uses pool
src/repository/users/usersRepo.ts - Reminder repository → PostgreSQL pool: uses pool
src/repository/reminder.ts - PostgreSQL pool → PostgreSQL: queries
README.md