ClassClock/ClassClock
1
0
Fork 0
Code Issues 30 Pull requests Releases 8 Activity Actions
ClassClock is a free, easy-to-use web app for K-12 schools that provides an at-a-glance view of the school schedule https://web.classclock.app
1,089 commits 13 branches 9 tags 3.7 MiB
  • TypeScript 92%
  • CSS 4.2%
  • HTML 3%
  • Shell 0.7%
Find a file
Adrian Edwards 281cb2d25d compare the audience values when displaying so they get sorted
2025-09-04 23:01:35 -04:00
.github point people to GH discussions for feature requests 2022-02-01 21:03:39 -05:00
public remove raygun monitoring 2022-05-30 14:16:38 -04:00
scripts set yarn version to berry when deploying 2024-10-08 22:34:11 -04:00
src compare the audience values when displaying so they get sorted 2025-09-04 23:01:35 -04:00
.dockerignore add dockerfile 2021-08-15 12:41:11 -07:00
.env remove non-private sentry DSN value from code 2023-12-31 14:46:27 -08:00
.gitignore yarn berry update 2024-10-08 20:27:38 -04:00
.prettierrc linting config 2019-06-24 20:22:11 -07:00
.travis.yml fix travis builds 2019-12-16 15:24:35 -05:00
.yarnrc.yml yarn berry update 2024-10-08 20:27:38 -04:00
_config.yml copy config.yml from landing page 2019-03-19 12:31:56 -07:00
CNAME Move to a new subdomain 2019-02-10 10:37:34 -08:00
docker-compose.yml make dummy credentials a *little* better 2021-09-03 12:53:29 -04:00
Dockerfile add dockerfile 2021-08-15 12:41:11 -07:00
LICENSE Add LICENSE.md 2019-06-12 19:42:30 -07:00
package.json version bump 2025-09-03 23:04:09 -04:00
README.md fix auth0 using the development client ID in prod 2024-04-08 23:03:23 -04:00
robots.txt Add robots.txt 2019-05-13 12:18:01 -07:00
tsconfig.json update tsconfig indentation 2020-12-24 15:49:00 -08:00
tslint.json update tslint rules 2019-07-15 23:00:27 -07:00
vercel.json add vercel config to prevent github comments on new builds 2021-05-10 13:50:17 -07:00
yarn.lock fontawesome updates 2024-10-08 20:35:30 -04:00

README.md

ClassClock Icon

ClassClock

Join the chat at https://gitter.im/MoralCode/ClassClock

What is ClassClock?

ClassClock is a web app to give students and teachers easy access to:

  • current date and time
  • daily schedules (You are on the Mon/Tues Schedule)
  • the class period you are currently in (i.e. 2nd Period)
  • a countdown until class is over
  • the generic name of your next class (i.e. 3rd Period)

ClassClock is useful for:

  • Teachers - to check how much teaching time is left in class
  • Students - to remind themselves of where they need to be and when
  • Parents - to see the optimal time to contact their student without interfering with instruction time
  • Everyone - to have quick and easy access to varied schedules that may otherwise be complicated, confusing or hard to remember

Upcoming Features

Here are some features to look forward to in a future version:

  • Support for multiple schools (currently only supports one)
  • Detection of block (A/B) schedules
  • Countdown to school breaks (winter break, spriing break, summer .etc)
  • Support for custom schedules (assemblies, parades, combined schedules etc.)
  • The ability to change what is displayed
  • The ability for students to upload their schedules to get more detailed information such as teacher name and room number

How to install?

ClassClock is a web-based app that can be saved to your phone's home screen or bookmarked in your browser for easy access.

iOS

  1. Navigate to ClassClock in Safari (not tested on other browsers)
  2. Click the "Share" or "Action" button (it looks like a square with an arrow pointing up out of the top)
  3. Click "Add to Home Screen" on the bottom row (you might have to scroll sideways to see it)
  4. Click "Done" in the top corner of the screen to add it to your home screen.

Android

  1. Navigate to ClassClock (instructions for Google Chrome)
  2. Click the "Overflow" button on the top right of your screen (it looks like three vertical dots)
  3. Click "Add to Home Screen" button in the menu (it's about 2/3 of the way down)
  4. Click "Add" in the dialog box that pops up to add it to your home screen.

Developer setup

Environment Variables

REACT_APP_AUTH0_DOMAIN - the domain for the auth0 tenant to use (provided in application details)

REACT_APP_AUTH0_CLIENT_ID - the client ID for the auth0 application to connect to

REACT_APP_AUTH0_AUDIENCE - the auth0 audience (probably your API URL) to use

REACT_APP_SENTRY_DSN - if you want to use sentry for monititoring errors, provide your DSN value from the sentry app so ClassClock knows where to send error information