Hometether docs
v1.0.0
Get help
● Start

Installation
app and server, step by step.

Commands below match README.md, server/README.md and the project files.

flutter pub getnpm ci

01Install and run the server

Windows users

Run the shell commands on this page in WSL 2 (Ubuntu), not in PowerShell: install Node.js inside WSL for the server commands. Flutter can also run natively on Windows for Android builds; iOS builds need a Mac. macOS and Linux users can ignore this note.

  1. Check Node: node -v should print 26.x (recommended) or at least 22.12.
  2. Create the settings file:
    cd server
    cp .env.example .env
  3. Make a secret key and paste it after ADMIN_SECRET_KEY= in .env:
    openssl rand -hex 32
    Keep a copy somewhere safe. It encrypts the store keys you save in the console.
  4. Install, build, start:
    npm ci
    npm run build
    npm start
    The server listens on port 8787. Test it: curl http://localhost:8787/healthz prints {"ok":true}.
  5. Open the console at http://localhost:8787/admin (next: Console).

Development shortcut: npm run dev builds and starts. Full check (type check, lint, tests, build): npm run check.

02Install and run the app

Windows users

Run the shell commands on this page in WSL 2 (Ubuntu), not in PowerShell: install Node.js inside WSL for the server commands. Flutter can also run natively on Windows for Android builds; iOS builds need a Mac. macOS and Linux users can ignore this note.

  1. Open a terminal in the app folder.
  2. Download packages:
    flutter pub get
  3. Run the tests (no device needed):
    flutter test
  4. Run on a device:
    flutter run --dart-define=API_BASE_URL=https://hometether.example.com
    The address is your server's origin, no trailing path. A phone cannot reach localhost on your computer, and remote help needs HTTPS (see Relay).
  5. Without a server just run flutter run: the parent's own remote and the guided fixes work; remote help is switched off.
iOS first time

Open app/ios/Runner.xcworkspace in Xcode, select the Runner target, Signing & Capabilities, and choose your own team. The project ships with an empty team. Run cd ios && pod install if Flutter asks for it.

Not run on a real TV or phone

The author ran the automated tests and release builds (Changelog). No real TV, phone, QR scan or store purchase was tried. Test on your own devices before you publish.