Skip to content

This is a small tool to help with registering people, to an Event or local-business or ... with ease and no backend

License

Notifications You must be signed in to change notification settings

akumagamo/pwa-my-checkin

Repository files navigation

"My CheckIn": Checkin App for Offline use

Versionnumber 0.1.0 (2020-10-18)

(Documentation last update 2020-10-18 20:30)

This is a small tool to help with checking in (registering) people, to an Event local-business, with ease and no backend. Data is stored online on the devices, that are used (but it can be exported).

screenhot main menu screen screenhot customer dataentry screen screenhot customer qr screen
Some Screens from the "Customer Mode"

Features

  • Works Offline (tested only on Android)
  • Splash Screen (Automatic from PWA)
  • User Frontend (to provide data in an fast and easy Way)
  • Business Frontend (for reading in data)
    • WebCam QR Code Scanner
  • Basic Styling

Roadmap / Future Features

  • Info Screen
  • Business Frontend
    • Manual entry of customers
    • Save data in a List
    • Export Data
      • Google Spreadsheet
      • CSV
      • ...
  • Test for disclaimer and Stuff
  • HP to promote this Tool
  • Real tight and slick Styling
  • Test on Iphone
  • Refactoring and Cleanup

Known Bugs

  • layout is sometimes a wonky (scrolling and offset)
  • back - history doesn't work 100%

Usage

This application has to run on an https server, with a valid Certificate, OR may functions like 'service-workers' and 'webcam' won't work.
There is a script to launch the "https-server" npm module, but you would have to create the needed certificates.

SourceControl Link & Information

https://github.com/akumagamo/pwa-my-checkin.git

Documentation

File / Folder Structure

 +-+- pwa-my-checkin
   +-+- css
   | +--- app.css
   +-+- docs
   | +-+- img                // images for manual.md
   | | +-- ...
   | +-+--- manual.md        // mini Screens overview
   +-+- img
   | +--- business.png
   | +--- user.png
   +-+- js
   | +--- app.js
   | +---qrcode-read.min.js   // external libraries
   | +---qrcode-write.min.js  // external libraries
   +-+- pwa                   
   | +-+-img
   |   +- icon-192v2.png
   |   +- icon-512v2.png
   +-+- readme               // images for reame.md
   | +-- ...
   +- .gitignore
   +- favicon.ico
   +- index.html
   +- LICENSE                 // License for ALL Files EXCEPT the external libraries in the js folder
   +- manifest.json 
   +- package.json
   +- readme.md (this document)
   +- service-worker.js

About

This is a small tool to help with registering people, to an Event or local-business or ... with ease and no backend

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published