Skip to content

About

the best frontend

Resources

Stars

2 stars

Watchers

0 watching

Forks

Latest commit

 

History

90 Commits

Folders and files

Repository files navigation

Untis app icon

webuntis-frontend

Your WebUntis timetable as a fast, modular desktop app.

Built on top of the untis command line tool, with far more knobs than the WebUntis web interface.

Made With:Agentic_Engineering CI Go TypeScript Tauri License: GPL-2.0

Features · Download · Quick start · Real timetable · How it works · Shortcuts · Development


Week view of the timetable showing the built-in sample data This is a sample timetable, not a real one. The screenshot shows the built-in sample data: the school, subjects, teachers and rooms are made up.

The app never talks to WebUntis itself. Login, sessions, caching and every API call stay in the untis CLI; this app runs it, turns its JSON into a clean model and gives you a GUI on top: 128 settings in 20 sections, a rebindable shortcut for every command, and per-subject names, colours and emoji.

✨ Features

🧩 Dashboard Widgets you choose, order and size: now & next (with progress and time left), agenda, upcoming changes, week stats, exams, homework, absences, messages, the next break and recent notifications
🗓️ Timetable By week or day, with a period-based or true-time scale, parallel groups side by side, merged double lessons, a current-time line, holidays and a detail dialog for every lesson
📚 Lists Exams, homework, absences, messages and holidays as list views, with countdowns, totals and grouping. Homework can be ticked off and messages marked read locally (this never changes WebUntis)
🔔 Change notifications Cancellations, substitutions, room changes, new exams and more, as in-app messages or desktop notifications, with quiet hours and a switch per change type
🎨 Subjects your way Rename, recolour, add an emoji, hide, filter with only/except, and choose codes, full names or both
🌗 Theming Light/dark/system, palettes and presets, accent and per-state colours, four ways to draw lesson states, fonts, density, radius and custom CSS
🌍 Localisation English and German, first day of week, 12/24 h clock, date format and relative dates
⌨️ Keyboard first Command palette (Ctrl/Cmd+K) and shortcuts such as g t for the timetable, all rebindable
⬆️ Updates An update button appears when a newer release exists and fetches the right file for your platform and installation. Nothing is installed without your click
🧪 Sample data A fully fictional school is built in, so the app works without any account

📦 Download

Grab the latest version from the releases page:

Platform Desktop app Web edition (runs in the browser)
Windows x64 / ARM64 .exe installer, .msi, portable .zip .zip (x64, ARM64, x86)
macOS (Apple Silicon + Intel) .dmg, .app .tar.gz (arm64, amd64)
Linux x64 / ARM64 .deb, .rpm, .AppImage, portable .tar.gz .tar.gz (also armv7, armv6, 386, riscv64, ppc64le, s390x, loong64)
FreeBSD, OpenBSD, NetBSD, DragonFly — .tar.gz (amd64, arm64, 386, armv7)
illumos, Solaris — .tar.gz (amd64)

Which file to pick and how to start it is explained in the installation guide.

🚀 Quick start from source (sample data)

Requirements: Go 1.23+, Node 22+ with pnpm, and Rust plus the Tauri prerequisites for the desktop app.

git clone https://github.com/seesee010/webuntis-frontend
cd webuntis-frontend/desktop && pnpm install && cd ..

make app        # desktop app (builds the backend sidecar first)

Or run it in a browser while developing, with two terminals:

make backend-dev   # untisd on 127.0.0.1:47800 with sample data
make dev           # Vite on http://localhost:1420

Tip

The app starts with sample data: a made-up school, student, teachers and rooms, generated relative to the current week so that every lesson state, countdown and notification shows up. It is the same data you see in the screenshot above.

🔑 Using your real timetable

  1. Install and set up the CLI once:

    pipx install git+https://github.com/seesee010/webuntis-scraper
    untis init
  2. In the app, open Settings › Data source and switch the source to untis CLI. The executable, transport, cache age (--max-age), offline mode, --config/--env paths, extra arguments and the timeout are all configurable there.

Status shows the CLI version, the last refresh and any error. Errors from the CLI (missing setup, rejected login, WebUntis unreachable) show up as a banner with a hint on what to do.

🔧 How it works

flowchart LR
  subgraph app["Desktop app (Tauri)"]
    fe["<b>TypeScript frontend</b><br>modules: dashboard,<br>timetable, settings, …"]
    be["<b>untisd (Go)</b><br>service: cache,<br>refresh, changes"]
    fe -- "HTTP + SSE<br>(loopback, token)" --> be
  end
  be -- "runs<br>untis --json - --from … --to …" --> cli["<b>untis CLI</b>"]
  cli --> wu[("WebUntis")]
Loading
  • desktop/src-tauri is a thin Rust shell. It starts the Go backend as a sidecar, reads its {"port", "token"} handshake line and hands it to the frontend.
  • backend/ (untisd) serves a small HTTP API on 127.0.0.1 with a per-process token. It caches snapshots per date window, refreshes in the background, diffs consecutive snapshots into change events and streams them to the frontend as server-sent events.
  • desktop/src is a framework-free TypeScript frontend made of modules. Each module declares its page, dashboard widgets, settings and commands in one place.

See docs/architecture.md for the details, including how to add a module.

⚡ Keyboard shortcuts

Keys Action
Ctrl/Cmd+K command palette
g d g t g e g h g a g m g b g s go to dashboard, timetable, exams, homework, absences, messages, holidays (breaks), settings
← → t w d timetable: previous, next, today, week, day
r refresh
Ctrl/Cmd+B toggle the sidebar
Ctrl/Cmd+Shift+L light/dark
? list all shortcuts

Every shortcut can be changed under Settings › Keyboard shortcuts.

💻 Development

make test      # Go, TypeScript and Rust tests
make lint      # go vet + tsc
make build     # release bundle

Every change comes with tests, and CI must be green before a pull request is merged. Tests only use made-up data and never run the real untis CLI.

Where things live
Path What
backend/cmd/untisd backend entry point
backend/internal/domain normalised data model
backend/internal/untisjson decoding of the CLI's JSON
backend/internal/provider data sources: sample, cli
backend/internal/service caching, refresh loop, change events
backend/internal/api loopback HTTP API and event stream
backend/internal/settings the settings document
desktop/src/core frontend runtime: API client, signals, router, settings, i18n, …
desktop/src/modules one folder per feature
desktop/src/i18n translations
desktop/src-tauri desktop shell

🔒 Privacy

  • The backend listens on the loopback interface only and requires a random per-process token.
  • Settings are stored in untis-gui/settings.json in your config folder (~/.config on Linux) with mode 600. Credentials stay with the untis CLI and never pass through this app.
  • The only request the app makes on its own is the update check: once a day it asks GitHub for the latest release of this repository. GitHub sees your IP address and the app version, nothing about your timetable or account. Settings › General › Check for updates switches it off.
  • Screenshots, fixtures and tests use only the built-in fictional data.

📄 License

GNU General Public License v2.0.

About

the best frontend

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages