Documentation

Technical documentation for the NestGuard platform.

NestGuard — Overview

What is NestGuard?

NestGuard is a biometric access control system designed for university hostels. It replaces manual sign-in registers with optical fingerprint authentication at gate terminals, providing real-time monitoring, AI-driven anomaly detection, and a permanent audit trail.

Architecture

The system consists of three layers:

  • Hardware Layer — AS608 optical fingerprint sensors + Arduino microcontrollers + relay-driven solenoid locks at each gate
  • Gateway Service — A Node.js service bridging serial (UART) communication from Arduino to the main server via HTTP. Supports a simulated mode for demos.
  • Web Application — Next.js frontend with a Node.js/Express backend. Handles user management, access log storage, analytics, visitor management, and the real-time dashboard.

Technology Stack

FrontendNext.js 15, React 19, Tailwind CSS 4, TypeScript
BackendNode.js, Express, Prisma ORM
DatabasePostgreSQL
AI/MLPython, scikit-learn (Isolation Forest)
HardwareArduino Uno, AS608 Sensor, Relay Module
GatewayNode.js, SerialPort library

User Roles

The system supports four roles: Admin (full system configuration), Warden (daily operations, visitor approvals), Security (monitoring and alert response), and Student (personal access history, visitor/leave requests).

Getting Started

# Clone and install
git clone https://github.com/your-org/nestguard.git
cd nestguard-frontend && npm install
npm run dev
NestGuard Logo Mark

Ready to secure your campus?

Deploy NestGuard OS to your gateway terminals and take absolute control of hostel safety today.

Log in to Console