How iamgideonidoko/bio-attendance-sys works
Project Type and Purpose
• The project is a full‐stack biometric attendance system.
• Its purpose is to track attendance by leveraging fingerprint biometrics, specifically with a DigitalPersona U.are.U 4500 scanner.
• The system uses a hybrid approach with a MERN-stack-based client and NodeJS/Express backend (in the “server” directory) for core API and database management. A separate Python backend (“server-py”) handles computer vision and fingerprint matching using OpenCV and Flask (or similar), ensuring accurate biometric processing.
Analyzing the File Structure – Key Components
A. Client:
• Located in the “client” directory.
• Contains a React/TypeScript application (files like App.tsx, index.html, and various UI components).
• Organizes API calls (found under client/src/api) and uses libraries such as axios (axios-client.ts) for HTTP requests.
• Contains environment configuration files and styling (SCSS files).
• Uses Vite for build configuration (vite.config.ts).
B. Core Backend (“server”):
• Written in NodeJS (TypeScript) with an Express-based architecture.
• Contains controllers, routes, services, and middlewares to manage business logic (e.g., authentication, attendance, course, and student handling).
• Uses Prisma as the ORM for database interactions with a MySQL database (directory “prisma” and migration files).
• Configuration and helper modules (JWT, logger, password, etc.) add to the robustness of the backend.
C. Biometric (Matching) Backend (“server-py”):
• A Python-based backend responsible for computer vision, fingerprint processing, and matching.
• Likely uses the DigitalPersona scanner's SDK and OpenCV for image processing.
• Contains a “requirements.txt” for dependency management, and supporting folder “fingerprints” for storing fingerprint images/templates.
A. Main Components to Represent:
• Client (Frontend): Show the React application running on Windows, equipped with the DigitalPersona client for fingerprint scanning.
• Core Backend: Display the NodeJS server handling RESTful API endpoints. Include its primary modules (controllers, routes, services) and configuration components.
• Database: Represent the MySQL database that is accessed via Prisma in the core backend.
• External Hardware: Include the DigitalPersona U.are.U 4500 scanner as an external input device connecting to the client.
B. Relationships and Interactions:
• If applicable, show a direct link between the DigitalPersona scanner and the Client.
C. Architectural Patterns and Design Principles:
• Separation of concerns by illustrating distinct layers: presentation (client), application/service layer (backend controllers and services), and data layer (database).
• RESTful API or controller-service patterns in the server.
• For the biometric processing, note the middleware process between hardware capture (client) and the matching logic in the Python server.