fegger/time_to_leave
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

update documentation

Browse Source
This commit is contained in:
Florian Egger
2026-05-18 15:01:53 +02:00
parent 834025e560
commit 7018443b18
13 changed files with 756 additions and 725 deletions
Download Patch File Download Diff File Expand all files Collapse all files
FEATURES_CHECKLIST.md
+44 -41
View File
@@ -1,54 +1,57 @@
# TimeToLeave — Features Implementation Checklist
# TimeToLeave - Features Implementation Checklist
## Phase 1 — New Settings Infrastructure (Steps 1-3)
This checklist tracks the route-planning and settings features currently implemented across the web and shared packages.
| # | Step | ✅ | ✔️ |
|---|---|----|----|
| 1 | Extend ReminderSettings type with 3 new fields | [x] | [x] |
| 2 | Update useReminderSettings hook with defaults + setters | [x] | [x] |
| 3 | Update ReminderSettingsPanel UI (slider + 2 toggles) | [x] | [x] |
## Settings Infrastructure
## Phase 2 — Walk Routing Infrastructure (Steps 4-6)
| # | Step | Done | Verified |
| --- | --- | --- | --- |
| 1 | Extend `ReminderSettings` with arrival buffer, walking visibility, and bike visibility | [x] | [x] |
| 2 | Persist reminder settings in web `localStorage` and mobile `AsyncStorage` | [x] | [x] |
| 3 | Add settings UI for reminder buffer, arrival buffer, notifications, walking, and bike options | [x] | [x] |
| # | Step | ✅ | ✔️ |
|---|---|----|----|
| 4 | Create WalkRoutingClient (OSRM foot profile) | [x] | [x] |
| 5 | Create /api/walk-route endpoint | [x] | [x] |
| 6 | Add getWalkRoute to api-client package | [x] | [x] |
## Routing Infrastructure
## Phase 3 — Departure Time Calculation (Steps 7-8)
| # | Step | Done | Verified |
| --- | --- | --- | --- |
| 4 | Add OSRM walking client and `/api/walk-route` endpoint | [x] | [x] |
| 5 | Add OSRM bike client and `/api/bike-route` endpoint | [x] | [x] |
| 6 | Add `getWalkRoute()` and `getBikeRoute()` to `@timetoleave/api-client` | [x] | [x] |
| 7 | Add web/mobile hooks for walking and bike routes | [x] | [x] |
| # | Step | ✅ | ✔️ |
|---|---|----|----|
| 7 | Create useDepartureTime hook | [x] | [x] |
| 8 | Update useClock to accept departureTime override | [x] | [x] |
## Departure Calculation
## Phase 4 — Mode Selector & EventCard Updates (Steps 9-11)
| # | Step | Done | Verified |
| --- | --- | --- | --- |
| 8 | Calculate leave-by time from selected transport mode | [x] | [x] |
| 9 | Account for final walking time before choosing train journeys | [x] | [x] |
| 10 | Support HAFAS arrive-by journey search with fallback window | [x] | [x] |
| 11 | Update countdown logic to use computed departure time | [x] | [x] |
| # | Step | ✅ | ✔️ |
|---|---|----|----|
| 9 | Create useWalkRoute hook | [x] | [x] |
| 10 | Create WalkingOption component | [x] | [x] |
| 11 | Update EventCard with mode selector + conditional rendering | [x] | [x] |
## Calendar and Event Management
## Phase 5 — TrainSection & JourneyList Updates (Steps 12-13)
| # | Step | Done | Verified |
| --- | --- | --- | --- |
| 12 | Import web calendars from URL and local ICS files | [x] | [x] |
| 13 | Add Google Calendar OAuth sync on web | [x] | [x] |
| 14 | Add batch destination review/editing for imported web events | [x] | [x] |
| 15 | Add mobile native calendar sync with calendar selection | [x] | [x] |
| 16 | Add event editing on web and mobile | [x] | [x] |
| # | Step | ✅ | ✔️ |
|---|---|----|----|
| 12 | Update TrainSection props (arrival buffer + walk option) | [x] | [x] |
| 13 | Update JourneyList with arrival buffer filtering | [x] | [x] |
## Transit Integrations
## Phase 6 — Verification & Testing (Steps 14-16)
| # | Step | Done | Verified |
| --- | --- | --- | --- |
| 17 | Add HAFAS station search and nearest-station lookup | [x] | [x] |
| 18 | Add HAFAS journey parsing with real-time delay/cancellation support | [x] | [x] |
| 19 | Add optional ÖBB GTFS train metadata enrichment | [x] | [x] |
| 20 | Add Wiener Linien nearby stops and monitor departures | [x] | [x] |
| # | Step | ✅ | ✔️ |
|---|---|----|----|
| 14 | Integration verification (manual testing) | [ ] | [ ] |
| 15 | Build verification (typecheck, lint, test, build) | [x] | [x] |
| 16 | Update api-client exports | [x] | [x] |
## Verification
---
**Legend:**
- ✅ = Done (code written)
- ✔️ = Verified (tests/builds pass)
- `[~]` = Optional or deferred (never blocks phase advancement)
| # | Step | Done | Verified |
| --- | --- | --- | --- |
| 21 | Web unit and route tests | [x] | [x] |
| 22 | Mobile store, calendar, notification, and screen tests | [x] | [x] |
| 23 | Root lint/typecheck/test scripts documented | [x] | [x] |
| 24 | Manual integration checklist updated | [x] | [x] |