๐Ÿ“ฆ nuke-web3 / kickback-checkin-display

๐Ÿ“„ README.md ยท 41 lines
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41# Kickback Auto Check-In Display

### App to display a Time One Time Password (TOTP) for a Kickback event.

- Event host provides a secret/passphrase that is (presently) unchecked by kickback
  - [ ] TODO: Get kickback API integrated to check seceret and gather event information to display along with the TOTP code
- QR code and text TOTP are shown and rotated at `step = X seconds` and `window = 1` (code is valid for `step*(window+1)` time) _present step is 5 seconds_
  - User enters/scans code on [Kickback App](https://github.com/wearekickback/app/) to check-in automatically **if the code used is valid**.


#### Live Demo: https://nukemandan.github.io/kickback-checkin-display

## Integration with Kickback in [This PR](https://github.com/wearekickback/app/pull/227)

## Developer Notes:

Install:
```bash
npm install
```

Run Dev Server:
```bash
npm run dev
```
Build Static Site:
```bash
npm run build
```

_note: build is configured to go to `docs` folder in `quasar.conf.js` for github pages_

## License

GNU Affero General Public License v3.0

### :heart: Open Source Tools Used

-   [Quasar](https://quasar.dev): A [Vue](https://vuejs.org/) Webapp Framework
-   [otpLib](https://github.com/yeojz/otplib)