TapAuth is the product name regardless of the local checkout folder. I keep this page as the shortest route from installation to the operational detail needed on a real kiosk.
- Getting started: Raspberry Pi requirements, setup, service checks, and updates.
- Architecture: NFC flow, local registry, MySQL, and optional Firebase boundaries.
- Main README: capabilities, configuration, commands, limitations, applications, and connected projects.
scripts/setup_raspberry_pi.sh: first installation.scripts/update_pi_from_github.sh: update an installed Pi and reconcile the local registry.scripts/diagnose_nfc.sh: reader and service diagnostics.scripts/sync_realtime_db.py: explicit MySQL-to-Firebase synchronization.- Support: problem reports and diagnostic context.
- Security: private vulnerability reporting and data safety.
Keep .env, database credentials and exports, service-account files, student
records, NFC UIDs, and data/registered_cards.json out of version control.
Back up operational data before updates.
- Contributing: checks and release checklist.
- Changelog: user-visible changes.
- TapAuth 1.1.3 release notes.
- TapAuth 1.1.0 release notes.
- Citation metadata.