VS Attendance Client (Admin)

Refer to API documentation for system architecture diagram.

Overview

Web app for allowing students to clock in/out of campus using a QR code. Every 5 minutes, a new QR code is retrieved and rendered which encodes the student client url along with an access token that expires after a limited amount of time. When scanned, the device redirects the user to that URL where they are able to clock in/out.

Getting Started

# install dependencies
npm i

# run dev server (default ngrok tunnel points to port 5500, which is LiveServer's default port). If using VS Code, simply open repository in a dev container and run using LiveServer. Otherwise use any dev server extension/library to serve /index.html
npm run dev

Deployment

GitHub action workflows can be found here. Currently using Surge.sh for deployment to QA and Production environments. Please see repository owner for credentials.