How jawaid-aziz/attendance-system works
Project type and purpose
• This is a full-stack web application called “Office Attendance System.”
• Purpose: let admins and employees log in, record check-in/check-out, view attendance history, configure office timings and deductions, and enforce time-based salary adjustments.
File structure
• Top-level folders:
• client/ – React.js frontend (Tailwind CSS, Vite build)
• server/ – Node.js/Express backend
• Frontend patterns:
• src/Components, src/Pages, src/Context, src/lib, src/hooks → componentized UI with context providers and utility modules
• ProtectedRoutes for auth gating
• Backend patterns (server/):
• Routes/ – Express route definitions grouped by domain (auth, admin, attendance, common)
• controllers/ – route handlers organized by feature (attendanceController, adminController, TimezoneController)
• models/ – Mongoose (presumed) schemas: User.js, Attendance.js
• middleware/ – authMiddleware, authorizeAdmin, validateIP
• config/db.js – database connection setup
• utils/tokenUtils.js – JWT token helpers
Key architecture/stack notes from README
• Frontend: React.js + Tailwind CSS + Vite
• Backend: Node.js + Express
• Persistence: likely MongoDB (based on Mongoose-style models)
• Auth: JWT tokens; IP validation; role-based access
Main components
a. Frontend Client
• UI Modules (Components & Pages)
• Context Providers (Auth/Role/Theme)
• API Client (lib/api.jsx)
• Routing (React Router + ProtectedRoutes)
b. Backend Server
• API Gateway (Express app in server/index.js)
• Middleware Layer (authMiddleware, authorizeAdmin, validateIP)
• Route Handlers (Routes → controllers)
• Business Logic (controllers: attendance, admin, timezone)
• Data Access (models, config/db.js)
c. Database
• Collections: Users, AttendanceRecords
d. External/Infrastructure Services
• JWT token issuer/validator (tokenUtils)
• Environment config (.env)
• Possible third-party: IP geo-lookup (validateIP)
Relationships and data flows
1. User interacts with Frontend UI → triggers API calls via api.jsx
2. Frontend sends HTTP requests (Auth, Attendance, Admin config) → Backend Express
3. Express middleware sequence:
• validateIP → authMiddleware (JWT check) → authorizeAdmin (role check if needed)
4. After passing middleware, request reaches appropriate Route → Controller
5. Controller invokes Model to read/write DB
6. DB returns data → Controller packages JSON response → sent back to Frontend
7. Frontend Context providers store user session or theme preferences
Architectural patterns and principles
• Separation of concerns: UI layer vs. API layer vs. Data layer
• MVC-like on server: Routes → Controllers → Models
• Single-page application on client with component tree, hooks, and context
• Role-based access control and IP validation as cross-cutting concerns (middleware)
• Token-based stateless authentication
Elements
• Clear labels for each component (e.g., “AttendanceController,” “UserContext”)
• UI → API Client → Express → DB
• Express → Middleware → Controllers → Models → DB
• DB → Express → UI
• Frontend (blue rectangles)
• Backend (green rectangles)
• External/security services (JWT, IP validation) (gray)
• Technology next to each block (e.g., React.js, Node.js/Express, MongoDB)
• Environment/config (.env) feeding into Frontend build & Backend server