Cu-quickcheck NPM

Quick Check

Quick Check is a program to run the Daily Check for you! It does it quickly (usually in under 10 seconds, depending on the speed of your internet connection.)

By using this program, you affirm that you are submitting a true and complete Daily Check. Submitting a false Daily Check puts everyone at Cornell at risk. Don't do that. That is bad.

Install it with npm or yarn. If you don't have either installed, you can install npm by downloading Node.js, which can be done here.

$ npm i -g cu-quickcheck
$ yarn global add cu-quickcheck

Note that Quick Check installs an instance of Firefox, which does take up a bit of space (about 187 MB). You can look into alternate options on this page. Note that only Firefox is officially supported, and your mileage may vary with other browsers.

You can then configure Quick Check with the configure flag. The configuration file will be stored at ~/.quickcheck.json.

$ quickcheck --configure

Running Quick Check

Quick Check reads in from its configuration file located at ~/.quickcheck.json. You can generate a configuration file with quickcheck --configure. Quick Check takes no arguments as of right now.

$ quickcheck --configure # sets up quickcheck
$ quickcheck # runs quickcheck

Creating a Desktop Shortcut for Quick Check

You can create a simple shell script to run Quick Check, then put that on your desktop, and double click it to run. Note that on macOS your file must end in .command for it to be run with terminal by default. Otherwise, it will open in Xcode. You can see the run.command file for an example.

Project Priorities

The priorities for Quick Check are as follows. 1. Privacy. The Daily Check consists of personal health information, so no data should ever be sent to any party other than Cornell through the daily check website. 2. Usability. Quick Check should be usable by those without a strong technical background. 3. Speed. We should aim for an average time of under 10 seconds to complete the daily check.

Reporting Bugs

Bugs and issues can be reported on the GitHub issues page.

Quick Check's security

Quick Check deals with some pretty sensitive data, your NetID and password, as well as your Daily Check data. Storing sensitive data (such as API Keys and passwords) as environment variables is the industry standard.

Quick Check does not transmit any data outside your computer, apart from sending data to CUWebLogin and the Daily Check website

If you find any security flaws, you can shoot me an email (william@barkoffusa.com) and encrypt it with my PGP Key. I'll do my best to patch it as quickly as I can, and I'll make sure to credit you!