Documentation

Account Overview


What you see under the Account menu are links to Dashboard, Timezone, and Devices.

Dashboard


This is the default landing page for all users, and it displays up to five, colored indicators with information at a glance, just as you would expect from a dashboard.

The first, in dark blue, is visible to all users signed on to the system. It indicates the user's current timezone settings. By default, this is set to "America/New_York".

The next, in green, is also visible to all users signed on to the system. It indicates the name of the first, optional login device the user has defined, if any.

The next indicator, in yellow-orange, is only visible to users having the role of Superuser or Administrator. It indicates the total number of users registered to the system.

The next indicator, in red, is also only visible to users having the role of Superuser or Administrator. It indicates nothing at all, really, but still offers a direct link to the sitewide OpenGraph tag form.

The last indicator, in pale blue, is visible to all users. It also indicates nothing at all, except a direct link to the documentation overview.

Timezone


This is self-explanatory. The user is presented with a dropdown menu containing a few hundred timezones, from which they are to choose exactly one. The user clicks Save Changes and saves their preferred timezone for the application to remember later. The point of the exercise is so that date and time values can always be shown to the user in a friendly way, and remain stored in the database in UTC form.

Devices


Add a Device

The Device Name is just a name to give each login device. The name should be informative, and can be used later for discretion's sake, rather than exposing the number itself to unnecessary screen time.

The Mobile Carrier list is the best list I can currently find of mobile carriers having SMS gateways ready to receive text messages sent from the application. If the user's carrier is not in that list, then the user is not going to be able to receive login codes from their mobile device(s). The list can be upgraded from within the application, if necessary.

The Mobile Number is the number to reach the device using SMS. The client-side validation rules for this number are defined dynamically, and depend upon the timezone chosen by the user. Unfortunately, the server-side validation is currently filtering for a US/North American based format like (123) 456-7890.


List Devices

As the name suggests, there is a list of all login devices defined by the user. There is currently no upper limit imposed on how many devices a user may define. From the list view, a user can delete any device.