Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
redsn0w422 committed Mar 1, 2017
1 parent 5fa8eeb commit 7985565
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
# effective-goggles

staff app for people to be able to log in and scan QR codes at the event
Effective Goggles is a (very simple) iOS app that allows event hosts to track participants for certain events.

This is designed to work with the [HackIllinois API](https://github.com/HackIllinois/api-2017). This is the current flow:

- An API admin sets up a Universally Tracked event (within the iOS app) that has a name and a duration. Currently, the UI checks the role in the JWT token that the API returns to determine if the logged in user can access the "new event" page.
- The API will begin tracking that event, and only allows each user to "participate" once. "Participation" is defined as a POST to the `/v1/tracking/:id` endpoint, where `id` is the user ID embedded in the QR code.
- Effective Goggles allows hosts to scan user's QR codes and the app will indicate if it is their first time participating in the currently tracked event.

Build/usage instructions TBD.

0 comments on commit 7985565

Please sign in to comment.