VMS — Visitor Management System

WhatsApp-first, QR-powered visitor management platform for Indian enterprises.

🏗 Project Structure

├── client/          → React + Vite + TailwindCSS frontend (14 screens)
├── server/          → Node.js + Express.js REST API + WebSocket
├── VMS_PRD.md       → Product Requirements Document (agent-friendly)
└── VMS_TASKBOOK.md  → Development task tracker (40 tasks, 5 phases)

🚀 Quick Start

Prerequisites

• Node.js 20+
• PostgreSQL 16+
• Redis 7+
• Meta WhatsApp Business Account (for notifications)

1. Set Up Database and Backend Server (XAMPP)

1. Download and install XAMPP.
2. Open the XAMPP Control Panel and start Apache and MySQL.
3. Open http://localhost/phpmyadmin in your browser.
4. Create a new database named vms_db.
5. Import the server/database.sql file into the vms_db database.
6. Copy the entire server directory into your XAMPP public folder (e.g. C:\xampp\htdocs\vms-server).

2. Set Up Client

cd client
npm install
npm run dev                 # Start frontend on :8083

3. Open in Browser

• Frontend: http://localhost:8083
• API Health: http://localhost/vms-server/api/

📋 Feature Overview

Feature	Description
📅 Appointments	Staff pre-books visitors with QR passes sent via WhatsApp
🚶 Walk-In	Self-registration with OTP, selfie, NDA, and printed QR sticker
🏭 Vendor Passes	Long-term gate passes with auto-expiry alerts
📲 WhatsApp	QR invites, OTP auth, host alerts, admin notifications
🛡️ Security Dashboard	Real-time kanban with live visitor count
📊 Reports	Daily logs with PDF/Excel export
🚫 Blacklist	Automatic cross-check on every entry attempt
🚨 Emergency Roster	One-click evacuation list of all on-premises visitors

🔐 Roles

Role	Access
Admin	Full system control, reports, blacklist, employee management
Staff	Appointment booking, visitor history, WhatsApp notifications
Security	Gate QR scanner, real-time dashboard, check-in/out

🛠 Tech Stack

Layer	Technology
Frontend	React.js + Vite + TailwindCSS
Backend	Node.js + Express.js + Socket.IO
Database	PostgreSQL + Prisma ORM
Cache	Redis (OTP, sessions, rate limiting)
Notifications	WhatsApp Business Cloud API (Meta)
Storage	Firebase Storage (selfie photos)
QR Engine	qrcode.js + Puppeteer (PDF badges)
Deployment	XAMPP

📖 Documentation

• VMS_PRD.md — Full product requirements
• VMS_TASKBOOK.md — Task tracker with 40 deliverables

📅 Timeline

11-day build sprint: June 9–20, 2026

---

Developer: Shreyas · JNEC, MGM University