Skip to content

joegeorge022/FastLabScan

 
 

Repository files navigation

FastLabScan - QR-based Lab Attendance System

FastLabScan is a Progressive Web App (PWA) designed to streamline lab attendance tracking using QR codes. The app is optimized for both desktop and mobile devices, with offline capabilities.

🌐 Live Demo

Try it out: FastLabScan

✨ Features

  • 📱 Progressive Web App (PWA) - installable on both mobile and desktop
  • 📷 QR Code scanning with front/back camera support
  • ⌨️ Manual entry option with PIN protection
  • 🔄 Real-time attendance tracking
  • ⏱️ Configurable session duration
  • 📊 Multiple export formats (Excel, CSV, JSON)
  • 🔌 Offline support
  • 📳 Haptic feedback on successful scans
  • 🔊 Audio feedback on scans
  • 📱 Responsive design for all devices

🚀 Getting Started

Installation (Mobile)

  1. Visit FastLabScan on your mobile browser
  2. For iOS:
    • Tap the share button
    • Select "Add to Home Screen"
  3. For Android:
    • Tap the menu (⋮)
    • Select "Add to Home Screen"

Installation (Desktop)

  1. Visit FastLabScan in Chrome
  2. Click the install button (➕) in the address bar
  3. Follow the prompts to install

💻 Development

# Clone the repository
git clone https://github.com/joegeorge022/FastLabScan.git

# Install dependencies
npm install

# Run development server
npm run dev

# Build for production
npm run build

# Start production server
npm start

🛠️ Built With

📱 PWA Features

  • Installable on both mobile and desktop
  • Works offline
  • Camera access for QR scanning
  • Push notifications (coming soon)
  • Automatic updates

🔒 Privacy

  • All data is stored locally on your device
  • No server-side tracking or analytics
  • Camera is only used for QR scanning
  • PIN protection for manual entry

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details

🙏 Acknowledgments

  • html5-qrcode for the QR scanning functionality
  • Vercel for hosting
  • All contributors and users of FastLabScan

Made with ❤️ by Joe George

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 92.8%
  • CSS 6.6%
  • JavaScript 0.6%