Ole-Morten Duesund
a829742fe6
Legg til Screenshots-seksjon i CLAUDE.md med: - Emulatoroppsett (AVD, headless start, fake GPS) - Maestro v2.3.0 for repeterbare skjermbiletesekvensar - Fastlane-mappestiar for alle tre språk - Liste over gjeldande skjermbilete Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
99 lines
5 KiB
Markdown
99 lines
5 KiB
Markdown
# Tilfluktsrom - Norwegian Emergency Shelter Finder
|
|
|
|
## Project Overview
|
|
Android app (Kotlin) that helps find the nearest public shelter (tilfluktsrom) in Norway during emergencies. Offline-first design: must work without internet after initial data cache.
|
|
|
|
## Design Principles
|
|
|
|
### De-Google Compatibility
|
|
The app must work on devices without Google Play Services (e.g. LineageOS, GrapheneOS, /e/OS). Every feature that uses a Google-specific API must have a fallback that works without it. Use Google Play Services when available for better accuracy/performance, but never as a hard dependency.
|
|
|
|
**Pattern**: Check for Play Services at runtime, fall back to AOSP/standard APIs.
|
|
- **Location**: Prefer FusedLocationProviderClient (Play Services) → fall back to LocationManager (AOSP)
|
|
- **Maps**: OSMDroid (no Google dependency)
|
|
- **Database**: Room/SQLite (no Google dependency)
|
|
- **Background work**: WorkManager (works without Play Services via built-in scheduler)
|
|
|
|
### Offline-First
|
|
This is an emergency app. Assume internet and infrastructure may be degraded or unavailable. All core functionality (finding nearest shelter, compass navigation, sharing location) must work offline after initial data cache. Avoid solutions that depend on external servers being reachable.
|
|
|
|
## Architecture
|
|
- **Language**: Kotlin, targeting Android API 26+ (Android 8.0+)
|
|
- **Build**: Gradle 8.7, AGP 8.5.2, KSP for Room annotation processing
|
|
- **Maps**: OSMDroid (offline-capable OpenStreetMap)
|
|
- **Database**: Room (SQLite) for shelter data cache
|
|
- **HTTP**: OkHttp for data downloads
|
|
- **Location**: FusedLocationProviderClient (Play Services) with LocationManager fallback
|
|
- **Background**: WorkManager for periodic widget updates
|
|
- **UI**: Traditional Views with ViewBinding
|
|
|
|
## Key Data Flow
|
|
1. Shelter data downloaded as GeoJSON ZIP from Geonorge (EPSG:25833 UTM33N)
|
|
2. Coordinates converted to WGS84 (lat/lon) via `CoordinateConverter`
|
|
3. Stored in Room database for offline access
|
|
4. Nearest shelters found using Haversine distance calculation
|
|
5. Direction arrow uses device compass bearing minus shelter bearing
|
|
|
|
## Data Sources
|
|
- **Shelter data**: `https://nedlasting.geonorge.no/geonorge/Samfunnssikkerhet/TilfluktsromOffentlige/GeoJSON/...`
|
|
- **Map tiles**: OpenStreetMap via OSMDroid (auto-cached for offline use)
|
|
|
|
## Package Structure
|
|
```
|
|
no.naiv.tilfluktsrom/
|
|
├── data/ # Room entities, DAO, repository, GeoJSON parser, map cache
|
|
├── location/ # GPS location provider, nearest shelter finder
|
|
├── ui/ # Custom views (DirectionArrowView), adapters
|
|
├── widget/ # Home screen widget, WorkManager periodic updater
|
|
└── util/ # Coordinate conversion (UTM→WGS84), distance calculations
|
|
```
|
|
|
|
## Building
|
|
```bash
|
|
./gradlew assembleDebug
|
|
```
|
|
|
|
## Build Variants
|
|
- **standard**: Includes Google Play Services for better GPS accuracy
|
|
- **fdroid**: AOSP-only, no Google dependencies
|
|
|
|
## Distribution
|
|
- **Forgejo** (primary): `kode.naiv.no/olemd/tilfluktsrom` — releases with both APK variants
|
|
- **GitHub** (mirror): `github.com/olemd/tilfluktsrom` — automatically mirrored from Forgejo, do not push manually
|
|
- **F-Droid**: Metadata maintained in a separate fdroiddata repo (GitLab fork). F-Droid builds from source using the `fdroid` variant and signs with the F-Droid key.
|
|
|
|
## Screenshots
|
|
|
|
Use the Android emulator and Maestro to take screenshots for the README and fastlane metadata.
|
|
|
|
### Emulator setup
|
|
- AVD: `tilfluktsrom` (Pixel 6, API 35, google_apis/x86_64)
|
|
- Start headless: `~/android-sdk/emulator/emulator -avd tilfluktsrom -no-window -no-audio -no-boot-anim -gpu swiftshader_indirect &`
|
|
- When both a physical device and emulator are connected, use `-s emulator-5554` with adb
|
|
- Set fake GPS: `adb -s emulator-5554 emu geo fix <longitude> <latitude>` (note: longitude first)
|
|
- Grant permissions before launch: `adb -s emulator-5554 shell pm grant no.naiv.tilfluktsrom android.permission.ACCESS_FINE_LOCATION`
|
|
- Always cache map tiles ("Lagre kart") — never skip caching for screenshots
|
|
|
|
### Maestro (v2.3.0)
|
|
- Installed at `~/.maestro/bin/maestro`
|
|
- Use Maestro flows for repeatable screenshot sequences instead of manual `adb shell input tap` coordinates
|
|
- Maestro can target a specific device: `maestro --device emulator-5554 test flow.yaml`
|
|
- Place flows in a `maestro/` directory if creating reusable screenshot workflows
|
|
|
|
### Screenshot destinations
|
|
Screenshots go in all three fastlane locale directories:
|
|
- `fastlane/metadata/android/en-US/images/phoneScreenshots/`
|
|
- `fastlane/metadata/android/nb-NO/images/phoneScreenshots/`
|
|
- `fastlane/metadata/android/nn-NO/images/phoneScreenshots/`
|
|
|
|
Current screenshots:
|
|
1. `1_map_view.png` — Map with shelter markers
|
|
2. `2_shelter_selected.png` — Selected shelter with direction arrow
|
|
3. `3_compass_view.png` — Compass navigation with north indicator
|
|
4. `4_civil_defense_info.png` — Civil defense instructions
|
|
5. `5_about.png` — About page with privacy statement
|
|
|
|
## i18n
|
|
- Default (English): `res/values/strings.xml`
|
|
- Norwegian Bokmål: `res/values-nb/strings.xml`
|
|
- Norwegian Nynorsk: `res/values-nn/strings.xml`
|