Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 2.97 KB

File metadata and controls

53 lines (37 loc) · 2.97 KB

Attendance

An FRC-focused attendance tracker.

Features

  • QR Code Logins: Students can scan a QR code to sign in
  • Fully encrypted: All student information is fully encrypted, complying with NYS-ED laws (or so I'm told)
  • Admin Dashboard and Editor: Admins can view and edit attendance records, student information, and more.
  • Hour Types: Record build season, learning days, offseason, or outreach hours separately.
  • API: Includes a REST API with OpenAPI documentation at /api/docs or /api/openapi.yml
  • Mobile Friendly: Includes a seperate mobile interface for both students and admins

Deployment

  1. Deploy the docker container. Railway is by far the easiest way to do this.

    Deploy on Railway

    1. To set the timezone (TZ), use the database timezone format (TZ Identifier column).
    2. Set the JWT_SECRET to a large (>32 character), random password. You do not need to remember this.
  2. On your app's dashboard, select onlycs/attendance, and then Settings > Networking. If your team has a domain (e.g. attendance.team2791.org), add a Custom Domain. Otherwise, generate a domain.

    URL Settings
  3. Visit https://<your-domain>/onboard, and click Get a new setup token. To view this, in Railway, select onlycs/attendance, and then Deployments > View Logs.

Logs Setup Token

  1. Use the setup token, enter the initial admin username and password, and you're all set!

Further configuration

  • Inviting Admins: Settings > Invitation
  • Student ID Format: Settings > User Management > Student ID Configuration
  • Hour Goals or Requirements: Settings > Attendance
  • Change Username or Password: Settings > My Account

Screenshots

Attendance UI Admin Dashboard Admin Settings UI Hours Editor

Student Mobile UI Login Page