ClassMate configuration guide

Local desktop admin + public domain for students, sync, and WhatsApp webhooks.

1. Install (Windows)

  1. Download the Windows installer or build with npm run tauri:build
  2. Run setup — WebView2 is included on Windows 11
  3. Launch ClassMate and sign in (change demo passwords immediately)
RoleEmailDefault password
Adminadmin@classmate.localadmin123
Teacherteacher@classmate.localteacher123
Studentstudent@classmate.localstudent123
Parentparent@classmate.localparent123

2. Local-only use (no domain)

  1. Create courses, users, and assignments in the desktop app
  2. Class Hub — start a session; share the LAN join URL shown on the Hub page
  3. Backup — Settings → Backup & restore → export JSON regularly
  4. Data lives in a SQLite file on your PC (AppData) — no separate database server

3. Public domain (e.g. cm.codes-ai.uk)

Point DNS A record cm → your server IP (Ionos VPS).

This server runs classmate-server on port 8766. nginx proxies:

In the desktop app: Settings → LAN peer sync → Public base URL = https://cm.codes-ai.uk, hub path /hub.

Then run certbot --nginx -d cm.codes-ai.uk on the server for HTTPS.

4. Sync desktop ↔ server

  1. On server: systemctl status classmate-server (always on)
  2. On Windows: Settings → Start sync server (optional if server handles webhooks)
  3. Use the same sync token on both machines
  4. Push to peer / Pull from peer with URL https://cm.codes-ai.uk/api/sync/ and header token

5. Class Hub (live class)

  1. Hub page → pick course → Start hub
  2. Share join URL (uses public domain when configured)
  3. Students open URL on phones — PIN required

6. WhatsApp Business API

  1. Settings → WhatsApp Business API — phone number ID, access token, verify token
  2. Meta webhook URL = value shown in Settings (must be HTTPS)
  3. Subscribe to: messages, group_lifecycle_update, group_participants_update, group_settings_update, group_status_update
  4. Groups page — link or create native groups; enable member opt-in before sending

Source: github.com/avaisqarni365/classmate · Download