How dwarffyz/key_borrowing_system works
Key Borrowing System is a web application for campus key borrowing, administration, and optional ESP32-controlled lockers. Users authenticate, scan a QR code, and record a borrow or return; administrators manage keys and lockers, users, QR codes, reports, announcements, and system activity. The Express server coordinates the web API and MongoDB models, while the ESP32 firmware provides a separate locker-control and captive-portal path. The README documents these capabilities, but the server and browser excerpts are partial, so some feature-level connections are documented rather than traced through individual routes.
Main entry points: server.js API server · html Web interface · admin-script.js Admin console · scan-script.js QR scanning
Components 21
Web experience
- Web interface
public/html - QR scanning
public/js/scan-script.js - Admin console
public/js/admin-script.js - Dashboard
public/js/dashboard-script.js
Application API
- API server
public/server/server.js
Domain records
- User accounts
public/server/models/User.js - Admin accounts
public/server/models/Admin.js - Keys
public/server/models/Key.js - Lockers
public/server/models/Locker.js - QR codes
public/server/models/QRCode.js - Transactions
public/server/models/Transaction.js - Activity logs
public/server/models/ActivityLog.js - Announcements
public/server/models/Announcement.js - Feedback
public/server/models/Feedback.js - Maintenance
public/server/models/Maintenance.js - Lost reports
public/server/models/LostReport.js
Locker device
- ESP32 controller
hardware/esp32-locker-controller/main.c - Captive DNS
hardware/esp32-locker-controller/components/dns_server/dns_server.c
Other components
- Key borrower
- Administrator
- MongoDB
Connections 22
- Key borrower → Web interface: uses
README.md - Administrator → Web interface: uses
README.md - Web interface → QR scanning: scans QR
README.md - Web interface → Admin console: administers
README.md - Admin console → Dashboard: views reports
README.md - QR scanning → API server: records transactions
README.md - Admin console → API server: manages records
README.md - Dashboard → API server: requests status
README.md - API server → MongoDB: connects
public/server/server.js - API server → User accounts: uses
public/server/server.js - API server → Admin accounts: uses
public/server/server.js - API server → Keys: uses
public/server/server.js - API server → Lockers: uses
public/server/server.js - API server → QR codes: uses
public/server/server.js - API server → Transactions: uses
public/server/server.js - API server → Activity logs: uses
public/server/server.js - API server → Announcements: uses
public/server/server.js - API server → Feedback: uses
public/server/server.js - API server → Maintenance: uses
public/server/server.js - API server → Lost reports: uses
public/server/server.js - API server → ESP32 controller: controls lockers
README.md - ESP32 controller → Captive DNS: uses captive DNS