mirror of https://github.com/DRYTRIX/TimeTracker.git synced 2026-05-09 14:00:08 -05:00

Files

T

Dries Peeters bd00e01876 Add configurable date/time format and misc fixes

- Settings: add date_format and time_format (model, migration 119, admin UI)

- Use user date/time prefs in templates, calendar, and PDF export

- Expense: eager-load client instead of category in repo, service, and API

- Mobile: clarify server URL and certificate docs, bump to 4.18.0, improve connection diagnostics

- Ignore mobile/android/.gradle/

Co-authored-by: Cursor <cursoragent@cursor.com>

2026-02-07 08:22:34 +01:00

4.5 KiB

Raw Permalink Blame History

TimeTracker Mobile App

Flutter mobile application for Android and iOS that integrates with the TimeTracker REST API.

Features

⏱️ Time Tracking - Start, stop, and manage timers
📊 Projects & Tasks - View and select projects and tasks
📝 Time Entries - View and manage time entries with calendar
🔄 Offline Support - Work offline with automatic sync
🔐 Secure Authentication - Sign in with your web username and password; the app obtains an API token in the background for the same basics access as the web app

Setup

Prerequisites

Flutter SDK 3.0.0 or higher
Android Studio / Xcode for platform-specific setup

Installation

Install dependencies:

flutter pub get

Run code generation (for Hive adapters):

flutter pub run build_runner build

Run the app:

flutter run

Configuration

Signing in

Use the same username and password you use to log in to the TimeTracker web app. The mobile app signs you in via the API and obtains an API token in the background, giving you the same basics access (timer, time entries, projects, tasks) as on the web.

Launch the app on your device
On the login screen, enter:
- Server URL: The exact base URL you use in the browser for the TimeTracker web app. If the web app opens at https://example.com/timetracker/ (with a path), use https://example.com/timetracker as the Server URL — no trailing slash. If it opens at https://example.com/, use https://example.com.
- Username: Your web login username
- Password: Your web login password
Tap "Login"
The app will validate your credentials and navigate to the home screen if successful

Server URL and HTTPS

The default TimeTracker deployment uses docker-compose with NGINX on ports 80 and 443 (HTTPS). Use your server’s HTTPS URL (e.g. https://your-server.com) with no port unless you use a custom one.

Production: Use a valid certificate (e.g. Let’s Encrypt) so the app can connect without certificate errors.
Local / testing: Use a trusted CA (e.g. mkcert) for HTTPS, or HTTP only if your setup serves the API over HTTP (e.g. dev without NGINX).

Troubleshooting

"Invalid username or password" error:

Use the same username and password you use on the web app
Ensure the server URL is correct and the server is reachable

"Connection failed" or certificate errors (e.g. on DDNS or custom domains like timetracker.example.ddns.net):

Enter the exact base URL with https:// (e.g. https://timetracker.techteam.ddns.net) — no path and no trailing slash after the host.
If the server uses a self-signed or custom CA certificate, the app will show a "Certificate not trusted" dialog — tap "Yes, trust" to allow that host and retry.
For production, use a publicly trusted certificate (e.g. Let's Encrypt) for your hostname so the app connects without prompts.
Ensure the hostname resolves from the phone’s network (e.g. if the server is only reachable on office Wi‑Fi, connect the phone to that network or VPN).
Use the "Details" button on the error to copy diagnostics (URL, error type, message) for debugging.

General "Connection failed" error:

Verify the server URL is correct and accessible
Check your internet connection
Ensure the server is running and the API is accessible
For local development, use http://localhost:5000 or your local IP address

Offline Mode:

The app works offline and will sync when connection is restored
Time entries created offline are queued and synced automatically
Timer status is cached locally for offline viewing

Architecture

The app follows clean architecture principles:

Presentation Layer (lib/presentation/) - UI screens and widgets
Domain Layer (lib/domain/) - Business logic and use cases
Data Layer (lib/data/) - API client, local storage, models
Core (lib/core/) - Configuration, themes, constants

API Integration

The app integrates with the TimeTracker REST API (/api/v1/):

Timer endpoints: /api/v1/timer/start, /api/v1/timer/stop, /api/v1/timer/status
Time entries: /api/v1/time-entries
Projects: /api/v1/projects
Tasks: /api/v1/tasks

See the main project's API documentation for details.

Building

Android

flutter build apk --release
# or
flutter build appbundle --release

iOS

flutter build ios --release

Then open Xcode to archive and distribute.

4.5 KiB Raw Permalink Blame History Unescape Escape