PuruVJ / auto-class-launcher

Home Page:auto-class-launcher-alarm.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Auto Class Launcher

This is a little script I wrote to launch my classes 5 minutes before! But it is highly customisable, and you can download it and use it for yourselves! Just feed it your timetable and it will work flawlessly.

Features

  • 🚀 Launches your class link 5 minutes before the time.
  • ⏰ If link can't be provided, launches an alarm clock page for you
  • Available for Windows, Linux and macOS(Intel and M1)

Alarm Clock page

Who is this for?

  1. This tool will only be useful if you have same links for each subject throughout, and your weekly schedule is same. If it changes week to week, this script isn't for you.

  2. The timetable is stored in a JSON file on your computer. There's no Graphical User Interface. You should know how to navigate your computer's filesystem, and have confidence in editing configuration files.

Getting started

Go to the Releases page. There, you'll see some files under the Assets section

Release assets

These are all executable binary files. Click on the file suitable for your operating system

  • If you're on Ubuntu or any other Linux, go for class-launcher-linux file
  • If on Windows, go for class-launcher-windows.exe
  • If on macOS
    • If you're on a MacBook/Mac with an Intel chip processor, go for class-launcher-apple-intel
    • If you're on the new M1 chip macBook/Mac, go for class-launcher-apple-m1

When you download your file, simply double click on it to run it. And that's it!! You're almost done.

Editing the timetable

When you launch the program the first time, you'll see this screen

Welcome screen of the program

The config file is located right next to this program you are running, and it's named auto-class-launcher-timetable.json

So you open up the file, and you see this 👇

{
  "disc-structures": {
    "link": "https://meet.google.com/txo-tvbd-zvt?authuser=2",
    "times": [
      {
        "day": "tue",
        "time": "12:00"
      },
      {
        "day": "wed",
        "time": "12:00"
      },
      {
        "day": "thu",
        "time": "11:00"
      },
      {
        "day": "fri",
        "time": "15:00"
      }
    ]
  },
  "eng-graphics": {
    "link": "https://meet.google.com/uaa-brhr-rwy?authuser=2",
    "times": [
      {
        "day": "mon",
        "time": "12:00"
      },
      {
        "day": "thu",
        "time": "14:00"
      },
      {
        "day": "mon",
        "time": "12:00"
      }
    ]
  },
  "env-design": {
    "times": [
      {
        "day": "sun",
        "time": "23:08"
      }
    ]
  }
}

What you see is the author's timetable here. You'll have to modify it to suit your own needs. As you can this follows the pattern:

subject:
  link: "LINK TO OPEN"
  times:
    day: "The day of class. Can be mon or tue or wed or thu or fri or sat or sun"
    time: "hh:mm"

So all you have to do is change the subject names in it, the links, and the times.

What if I don't have a link (Or link changes every once in a while)?

In that case, afraid you can't provide a link. But you can use the Alarm Clock feature. If you don't provide a link, but specify the times, it will automatically open up a webpage 5 minutes before reminding you that you have a class.

Alarm Clock page

Example:

"env-design": {
    "times": [
      {
        "day": "sun",
        "time": "23:08"
      }
    ]
  }

As you can see, the time is defined, but no link provided.

Contributing

Contributions of all sorts are welcomed. If you want to contribute to auto-class-launcher, there are three ways you can do so:

  1. Feature Requests If you feel that there's a feature this app is lacking, post a feature request.

  2. Testing There are cases when fixing a bug triggers another bug, which I might not notice during testing myself. Having more users would be a great help to close in on such bugs. If you encounter some bugs, post an issue regarding the bug.

  3. Pull Requests I'm maintaining this open-source project as a personal interest without any profits, hence I'll only be developing auto-class-launcher if I have the time and motivation to do so. Therefore, PRs from other developers are highly welcomed.

About

auto-class-launcher-alarm.vercel.app


Languages

Language:Go 52.6%Language:Svelte 23.0%Language:SCSS 12.1%Language:HTML 6.0%Language:JavaScript 3.1%Language:Shell 3.0%